CCS C Software and Maintenance Offers
FAQFAQ   FAQForum Help   FAQOfficial CCS Support   SearchSearch  RegisterRegister 

ProfileProfile   Log in to check your private messagesLog in to check your private messages   Log inLog in 

CCS does not monitor this forum on a regular basis.

Please do not post bug reports on this forum. Send them to CCS Technical Support

Best Way To Document Code ?

 
Post new topic   Reply to topic    CCS Forum Index -> General CCS C Discussion
View previous topic :: View next topic  
Author Message
DonWare



Joined: 18 Jan 2006
Posts: 43

View user's profile Send private message

Best Way To Document Code ?
PostPosted: Tue Nov 14, 2006 9:06 am     Reply with quote

I'm fairly new to writing C (and loving it) and was wondering what you all might think is the best way to document my code. I briefly fooled around with Doxygen but it wasn't working out for some reason.

I'm mainly interested in variable lists, call trees, any 'big picture' info.

Since I compile via MPLAB I don't even know if the CCS software will do this.

Thanks, Don
davekelly



Joined: 04 Oct 2006
Posts: 53
Location: Berkshire, England

View user's profile Send private message

PostPosted: Tue Nov 14, 2006 9:22 am     Reply with quote

I use Doxygen as well.

As it uses embedded codes within comments, it is transparent to the CCS compiler.

It just takes a bit of effort to set it all up. Use the doxywizard.
Display posts from previous:   
Post new topic   Reply to topic    CCS Forum Index -> General CCS C Discussion All times are GMT - 6 Hours
Page 1 of 1

 
Jump to:  
You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum


Powered by phpBB © 2001, 2005 phpBB Group