On 7/9/13 1:01 PM, Bahadir Balban wrote: > Hi, > > Could you explain the purpose of markdown support with doxygen? Could > you give an example use case? > > Should markdown be embedded in source code comments? > > If I create individual markdown pages it seems that I cannot use any > doxygen commands such as \subpage. Should I use .dox pages and embed > markdown in it? > > So far I couldn't use doxygen commands and as an example cannot group > markdown pages on the left side page index. > > Thanks, > Bahadir I will use markdown at times in the documentation for an item where some formatting can make the documentation (doxygen output) clearer. It is a careful trade off, as it makes the documentation when reading the code itself a bit less clear (because of the "funny" markup) but due to the nature of markdown, it tends to be fairly readable (that seems to be one of the goals of markdown).
Sometimes adding a bulleted list or a table can make things more explicit. Note, I am putting the markdown within the normal commets that doxygen is processing to do this, so all the structure commands are still working. While you can make files be specifically markdown, I don't normally do this, I see this as a feature to use when you have some documentation that has already been prepared in markdown format, that you want to include as part of you documentation package (and then refer to it with subpage commands in your regular code. -- Richard Damon ------------------------------------------------------------------------------ See everything from the browser to the database with AppDynamics Get end-to-end visibility with application monitoring from AppDynamics Isolate bottlenecks and diagnose root cause in seconds. Start your free trial of AppDynamics Pro today! http://pubads.g.doubleclick.net/gampad/clk?id=48808831&iu=/4140/ostg.clktrk _______________________________________________ Doxygen-users mailing list Doxygen-users@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/doxygen-users
