Making ein bitbucket Quelle Wiki von javadocs

Question

Hallo, ich arbeite an ziemlich großen internen SDK, die wir für unsere Apps verwenden. Ich habe mit umfangreichen Javadocs ausgestattet. Jetzt ist es mein Ziel, .MD-Dateien aus diesen Javadocs zu erzeugen, so dass ich diese .md-Dateien direkt in mein bitbucket-Wiki schreiben kann.

Gibt es einen Weg dazu oder um ein anderes Dateiformat zu generieren, mit dem bitbucket wiki arbeiten kann?

Answer 1

Doxygen erscheint support Javadoc-style comments und kann output LaTeX. LaTeX kann von Pandoc konsumiert werden, die Markdown-Ausgabe unterstützt. Das ist etwas umständlich, aber es ist die einzige realistische Option, die ich sehen kann.

So etwas wie die folgende (nicht getestet)

# Generate a Doxygen configuration file, which 
# should enable LaTeX output by default 
doxygen -g 

# Generate LaTeX documentation in the latex/ directory 
doxygen 

# Generate one Markdown file for each LaTeX file 
find latex/ -name '*.tex' -exec mkdir -p markdown/`dirname {}` && \ 
    pandoc -o markdown/`basename {} .pdf`.md {} \; 

sollten Sie schließen erhalten.

Die Alternative könnte sein, Javadoc-generierten HTML-Code zu verwenden und diesen mit Pandoc aufzunehmen, um Markdown auszugeben.