Wiem, że w komentarzach można stosować markdown i doxygen może to zrozumieć. Ale muszę wiedzieć, czy można wygenerować dokumentację w formacie przeceny?Generowanie dokumentacji jako pliki do obniżania wartości za pomocą doxygen
Potrzebuję tych dokumentów do wygenerowania z plików C++.
Wiem, że to pytanie jest stary, ale wydaje się, że nowe narzędzie dostępne: https://www.npmjs.com/package/doxygen2md
Dzięki. To wygląda na dobry sposób na rozwiązanie problemu, który miałem. – Sudar
Nie wiem nic, co zrobi to bezpośrednio, ale Doxygen ma możliwość wyprowadzenia XML document using the XML generator.
Istnieją różne projekty, które obecnie nie mogą następnie zużywają wspomniane dane XML, aby go przekształcać, jedną z najprostszych, że jestem świadomy jest Breathe który służy do konwersji dokumentów XML na coś, co Sphinx można wykorzystać do dokumentacji wyjściowej używając Doxygen jako wstępnego procesora.
Kod Breathe może być dość prosty do użycia jako punkt wyjścia do generowania plików Markdown zamiast plików ReStructuredText wymaganych przez Sphinx. Nie przyjrzałem się kodowi Breathe, ale użyłem go do niektórych dużych projektów.
Oddychaj zawartość bezpośrednio do struktury drzewa Sphinx/docutils podczas przetwarzania plików Sphinx. Pliki pośrednie ReStructuredText nigdy nie są tworzone w procesie. –
Wygeneruj XML za pomocą DOXygen http://www.stack.nl/~dimitri/doxygen/customize.html#xmlgenerator.
Użyj PanDoc http://pandoc.org/ do konwersji XML na Markdown.
To jest fałszywa odpowiedź, "XML" to bardzo ogólny format, a pandoc nie obsługuje formatu XML doxygen. –
Chyba stosując surowe wyjście XML prawdopodobnie można napisać własny moduł konwersji Markdown. Ale jestem prawie pewny (nawet jeśli nie jest to 100%), bezpośrednie wyprowadzanie przecen nie jest możliwe. –