I'm using Doxygen for a github project, and I love the new support of
markdown, since that's GitHub's favored markup syntax, so it meshes nicely. 
What I'm trying to do is to have the README.md file be my Doxygen MainPage
and also the front page on my GitHub site (GitHub automatically does the
latter for a README.md file).

I got it to work by putting \mainpage at the top of my README.md file.  But
then it shows up in the markdown view of that file which doesn't looks so
great.  

On  http://www.stack.nl/%7Edimitri/doxygen/markdown.html this page , it
recommends writing:

Main Page              {\mainpage}
======

which looks even worse, since the {\mainpage} text shows up as part of the
(large) header.

I tried <!--- \mainpage --->, which makes it disappear from the markdown
view, but then doxygen doesn't seem to parse the fact that I want it to be
my main page.  So I guess doxygen skips the markdown comments as well.

So is there any way to get doxygen to parse the markdown comments?  Or is
there any other way to tell doxygen to make a file the MainPage without
needing to use \mainpage in the file itself?

Thanks in advance for any help with this.
-- 
View this message in context: 
http://old.nabble.com/Putting-%40mainpage-in-a-markdown-comment--tp34464466p34464466.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.


------------------------------------------------------------------------------
How fast is your code?
3 out of 4 devs don\\\'t know how their code performs in production.
Find out how slow your code is with AppDynamics Lite.
http://ad.doubleclick.net/clk;262219672;13503038;z?
http://info.appdynamics.com/FreeJavaPerformanceDownload.html
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Reply via email to