Investigate moxygen as a our XML (C++) to markdown parser

Question

Investigate moxygen as a our XML (C++) to markdown parser

Closed this issue 7 years ago · 5 comments

Currently we use a custom script https://github.com/dronecore/DroneCore/blob/master/generate_markdown_from_doxygen_xml.py

Answer 1 · 2017-09-13T02:49:36.000Z

I ran our source though MOxygen - you can see output here and sidebar for "our" output.
There are some bugs in rendering and everything is forced into one doc - possibly can be fixed.

At the moment I prefer our rendering, though this does have some "more correctness"

Answer 2 · 2017-09-13T05:51:03.000Z

What is "more correct"?

Answer 3 · 2017-09-13T07:55:30.000Z

That was a bit of a throwaway comment. What I should have said is that this probably covers a broader set of doxygen output - I just tested on our API, while this will have been tested on more examples. It is however still pre 1.0 release, and in no way any sort of defacto standard.
There are also rendering errors.

I prefer our rendering. We should revisit this in future though.

Answer 4 · 2017-09-13T08:15:43.000Z

Agreed, I think you did a nice job with your script for our use-case.

Answer 5 · 2018-01-11T04:34:13.000Z

Closing for now. Initial investigation showed no benefit. Maybe worth revisiting past gRPC