Developer forums (C::B DEVELOPMENT STRICTLY!) > Development

Documentation Software

<< < (2/3) > >>

280Z28:
For a public API, writing the API on a Wiki and then developing the library to work as stated is quite effective. Trac has helped me integrate that quite easily into one of my projects.

Michael:

--- Quote from: yop on December 20, 2005, 02:45:37 pm ---You can get the cb sdk documentation generated by DoxyS that Takeshi Miya built from the link in his post. I never heard of Doxys before but following his howto I built the sdk documentation and now I can't work without it (I have also loaded it to the help plugin and I get a search in documentaion right click entry, how great is that?). The output IMHO is by far better that Doxygen.

--- End quote ---

Thank you for the info. Yes, I have read the post of Takeshi Miya. At the time, I have just downloaded the CHM version and used it with the help plugin. I will give a try to Doxys.

Michael

takeshimiya:
In a perfect world we would have: the output produced by DoxyS, and the comments style of Natural Docs, being the program written in C++.

We could call it Natural DoxyS :P

BTW, I know another documentation generator, DocJet, which uses the same ideas, but it's more intelligent. Too bad it's commercial.

So for now, I would keep using DoxyS.

Game_Ender:
The advantage of the systems listed here vs the "Write an API and fulfill it" method is that they documentation is kept with the code, which means it much more likely to be kept up to date with what the code actually does.  I have the most experience with Doxygen myself, and I don't have much of a problem with its output style.  I think it would be great to have a plugin that included as many as possible, that way the user could decide.  I don't think it that much work to whip up a GUI that lets you select all the proper options.

I think it should be a two level selection, the first being the style of the documentation comments you wish to use, and based on that the plugin makes available what ever processors are available.  For the options given in this thread you would have "Natural Doc" style, and the "Doxygen" style.  For the Doxygen style you could either use Doxys or Doxygen to generate the output, and with Natural Doc style I guess you would only have the Natural doc style.

I don't know whether it would be best to invoke these programs or have the compiled into the program.  It would probably be easier to just invoke the external executable, and include a compiled version of the program with the binaries and instructions on how to get/compile it for the SVN version.

takeshimiya:
A documentation generator plugin should be easy to write, with support for all the documentation systems talked here.

Navigation

[0] Message Index

[#] Next page

[*] Previous page