Developer forums (C::B DEVELOPMENT STRICTLY!) > Development
Documentation in various formats
darklordsatan:
Havent downloaded/readed it yet (in download queue)
Maybe by means of customizing doxygen output we can generate man pages...
Writing Man-Pages - Linux Focus Magazine
mandrav:
--- Quote ---It is already possible to make SDK Docs (search the forum) doxygen is used for this. The only thing that should be done (in my opinion) is the layout. Also the doxygen-file should be made "multiplatform" and "multi user" so no hardcoded paths.. (Yiannis shall I change this?)
--- End quote ---
Yes, feel free to "play" with it.
Yiannis.
David Perfors:
--- Quote from: mandrav ---
--- Quote ---It is already possible to make SDK Docs (search the forum) doxygen is used for this. *snip* Also the doxygen-file should be made "multiplatform" and "multi user" so no hardcoded paths.. (Yiannis shall I change this?)
--- End quote ---
Yes, feel free to "play" with it.
--- End quote ---
Commited. also the tinyxml diretory is excluded, afterall this is not our own library ;) or are there many changes wich should be documented?
mandrav:
--- Quote ---or are there many changes wich should be documented?
--- End quote ---
No, just __declspec() attributes for exporting it from libcodeblocks.a. Nothing fancy :)
Yiannis.
RShadow:
--- Quote from: mispunt ---I agree with you both, we should try docbook.
Why manpages are silly? I think manpages are only usefull for commandline programs, and for libraries (so the sdk documentation could be a man page). Also I don't use manpages very much (I am not working on linux on a daily basis :P Do you know if it is possible to make man/info pages with doxygen (SDK) and DocBook>
--- End quote ---
I'm not sure if we can make man/info pages with doxygen or DocBook, but it wouldn't be too hard manualy. Man pages are just a simple variation of roff... I can do this task.. I will take the docbook sources and do the manpage thing with them.
--- Quote from: darklordsatan ---
Writing Man-Pages - Linux Focus Magazine
--- End quote ---
lol, I was just reading another linux magazine that had an article about writing man pages.. This is why I only subscribe to one magazine.. they all pretty much have the same articles :)
Navigation
[0] Message Index
[#] Next page
[*] Previous page
Go to full version