I would like to provide a documentation for my program in three different ways. Is there a way to easily achieve that task?

Hi experts,
I would like to have three kinds of documentation.
1. Have a class documentation (What a function really does, what my vars are good for,...)
2. I would like to give manpages for the UNIX version of the program
3. I would like to give some sort of documentation for the Windows version.

I assume, that #1 has to be solved independently of the other two.
Any suggestions?
Jens
LVL 5
allmerAsked:
Who is Participating?
I wear a lot of hats...

"The solutions and answers provided on Experts Exchange have been extremely helpful to me over the last few years. I wear a lot of hats - Developer, Database Administrator, Help Desk, etc., so I know a lot of things but not a lot about one thing. Experts Exchange gives me answers from people who do know a lot about one thing, in a easy to use platform." -Todd S.

jkrCommented:
>>I assume, that #1 has to be solved independently of the other two.

Not necessarily. Take a look at http://ccdoc.sourceforge.net/ - 'ccDoc' generates HTML documentation for your project. And, there's also 'c2man', that generates man pages from source code. 'ccDoc' should cover 1 and 3.
0

Experts Exchange Solution brought to you by

Your issues matter to us.

Facing a tech roadblock? Get the help and guidance you need from experienced professionals who care. Ask your question anytime, anywhere, with no hassle.

Start your 7-day free trial
waysideCommented:
Take a look at Doxygen (www.doxygen.org).

You put your comments (starting with //! insteadn of // ) in the source files using certain tags, then Doxygen can generate html documentation or man pages, or various other formats as well.

Here's a sample of comments for a member function of a class, showing some of the tags that are available. The web site listed above has links to projects that use Doxygen, so you can see what the output looks like.

//------------------------------
//! Stop monitoring bandwidth usage
//!
//! Decrements the counter keeping track of how many times
//! StartMonitoring() was called; when it hits zero, stop the
//! thread that is collecting performance data.
//!
//! If the forcestop argument is true, the thread is stopped
//! regardless of the counter value.
//!
//! @param bool forcestop - if true, forcibly stops the monitoring
//! thread
//!
//! @return the StartMonitoring counter value
//!
//! @see BandWidthThrottler::StartMonitoring()
//
int BandwidthThrottler::StopMonitoring(bool forcestop) {
...
}
0
allmerAuthor Commented:
Thanks,
I'll try it out.
Jens
0
It's more than this solution.Get answers and train to solve all your tech problems - anytime, anywhere.Try it for free Edge Out The Competitionfor your dream job with proven skills and certifications.Get started today Stand Outas the employee with proven skills.Start learning today for free Move Your Career Forwardwith certification training in the latest technologies.Start your trial today
C++

From novice to tech pro — start learning today.

Question has a verified solution.

Are you are experiencing a similar issue? Get a personalized answer when you ask a related question.

Have a better answer? Share it in a comment.