www.digitalmars.com         C & C++   DMDScript  

digitalmars.D.learn - Doxygen newbie

reply Chris Katko <ckatko gmail.com> writes:
I'm a complete doxygen newbie. But my first thought when writing 
comments is... why not use Markdown? (Which has become almost 
universal online these days.)

So I google it and Moxygen comes up. Which seems pretty good.

https://sourcey.com/generating-beautiful-markdown-documentation-with-moxygen/

So my question is, can you use Markdown with normal Doxygen? Is 
Moxygen needed? And if so, would I run into any complications 
using D instead of C/C++ with Doxygen and Moxygen?

Would there be any strange demangling issues or anything like 
that?

Thanks
Apr 23 2018
parent reply Jonathan M Davis <newsgroup.d jmdavisprog.com> writes:
On Monday, April 23, 2018 07:49:00 Chris Katko via Digitalmars-d-learn 
wrote:

 I'm a complete doxygen newbie. But my first thought when writing
 comments is... why not use Markdown? (Which has become almost
 universal online these days.)

 So I google it and Moxygen comes up. Which seems pretty good.

 https://sourcey.com/generating-beautiful-markdown-documentation-with-moxyg
 en/

 So my question is, can you use Markdown with normal Doxygen? Is
 Moxygen needed? And if so, would I run into any complications
 using D instead of C/C++ with Doxygen and Moxygen?

 Would there be any strange demangling issues or anything like
 that?


Historically, doxygen would not have interacted well with markdown at all,
but it looks like they added some markdown support with doxygen 1.8.0. This
page discusses it:

http://doxygen.nl/markdown.html

If you want to use doxygen with D, it should work just fine, but it's a
pretty atypical thing to do. D has its own built-in documentation generation
system, ddoc:

https://dlang.org/spec/ddoc.html

However, there are some alternatives that some in the D community use - the
most notable ones being ddox and adrdox. Several are listed on the dlang
wiki:

https://wiki.dlang.org/Documentation_Generators

- Jonathan M Davis
Apr 23 2018
parent Chris Katko <ckatko gmail.com> writes:
Oh goodness. I thought D was using Doxygen!

Thanks.
Apr 23 2018