Documentation Generation feature of the CCS IDE

Foppie · Joined: 16 Sep 2005 Posts: 138 Location: The Netherlands

Hello everyone,

I was wondering if someone had an usefull example for the generate documentation feature of the CCS IDE. I understand the basics of the feature but I cannot get it to work. I think I am doing something wrong in the comments in my .c-file. Also the help-file doesn't make if much clearer on what I am doing wrong.
I am using version 4.023 of the IDE.

Cheers, Jos

kender · Joined: 09 Aug 2004 Posts: 768 Location: Silicon Valley

Sorry, I can't answer your question diresctly. But I would like to mention Doxygen. It's open source, and it's safe to say that it became an industry standard.

Some folks are using it successfully with CCS http://www.ccsinfo.com/forum/viewtopic.php?t=28872

Foppie · Joined: 16 Sep 2005 Posts: 138 Location: The Netherlands

Hi Kender,

thanks for your reply, I have looked into doxygen but I think the CCS documentation generator is for my case more promising. I would really like to use it so I am hoping someone can give me an example of how to use it.

Cheers, Jos

tpm · Joined: 01 Feb 2005 Posts: 2

Any progress on getting this to work? I tried it this afternoon for the first time and cannot get any template variable to fill in.

Tim

DavidHudd · Joined: 07 Mar 2005 Posts: 2 Location: BRISTOL, U.K.

I have had the same problem. I have entered the exact labels in the code as shown in the manual (e.g. //*PURPOSE blah blah) but this is not placed in the documentation.
Has anyone used this feature? If so could you post an example.
The help files are not very "helpful"
Thanks,
David

jventerprises · Joined: 01 Apr 2004 Posts: 43 Location: Boston

I have the same problem, most of the fields do not fill in. maybe it is a 'work in progress'...
_________________
Jon

dyeatman · Joined: 06 Sep 2003 Posts: 1933 Location: Norman, OK

There is also a problem with the format source functions. On the longer programs I have it just hangs and never completes to the point I have to blow away CCS and restart the program.

I have sent the bug and the complete program code to CCS twice and they have not bothered to reply or fix the problem, it still hangs on the same code.

So apparently there are a few problems they have left to address and this area is a low priority on their list.. (somewhere in the future I hope?)

robhol · Joined: 11 Dec 2013 Posts: 1 Location: Sweden

Hello!

I wake-up this thread and ask the same question - does this generator work with the supplied template?

The help does not help much, in fact nearly not at all! Is there a manual somewhere how to code the source code to be understandable for the generator? Is there any description for how to modify the template that you know about? Or maybe I should ask, is there anybody using the doc gen at all?

For me it doesn't seem that CCS even has tested it once...

Maybe it was a mistake to buy the PCW. I have used PCM in MPLAB for long without trouble.

/Rob

PS I have the 4.141 version of the IDE.
_________________
---------------------------------------
PCWH (PCH + PCM + PCB) and ICD2/ICD3