doxygen

Jakie są nowe polecenia dokumentacji dostępne w Xcode 5? [zamknięte]

Jedną z nowych funkcji Xcode 5 jest możliwość dokumentowania własnego kodu za pomocą specjalnej składni komentarza. Format ... odzbiór tych funkcji . Które polecenia są obsługiwane, a które nie? Czy którekolwiek z ich zastosowań różni się od Doxygen?

Organizacja projektów C++ (z gtest, cmake i doxygen)

Jestem nowy w programowaniu w ogóle, więc zdecydowałem, że zacznę od stworzenia prostej klasy wektorowej w C++. Jednak chcia ... ? Przepraszam za tak wiele pytań, ale nie znalazłem książki O C++, która w zadowalający sposób odpowie na tego typu pytania.

Generatory dokumentacji Objective-C: HeaderDoc vs. Doxygen vs. AppleDoc

Muszę wdrożyć rozwiązanie generowania dokumentacji dla mojego miejsca pracy i zawęziłem je do trzech wymienionych w tytule. U ... yższych rozwiązań jest wyraźnie lepsze od pozostałych? Wszelkie sugestie lub informacje do dodania będą bardzo mile widziane.

Niestandardowe tagi z Doxygen

Próbuję dowiedzieć się, czy istnieje sposób na utworzenie niestandardowego znacznika za pomocą Doxygen. Znalazłem opcję pliku ... y listę tak jak to robi dla \bug i \todo poleceń dla linii, które mają ten niestandardowy znacznik. Czy to możliwe z Doxygen?

Jak zrobić stronę wprowadzającą za pomocą Doxygen

Zrobiłem dokumentację dla mojego SDK, używając Doxygen. Zawiera listę plików, przestrzeni nazw, klas, typów itp. - wszystko, ... ny bezpośrednio z żadnym elementem kodu. Chcę umieścić to wprowadzenie na stronie startowej dokumentacji. Jak mogę to zrobić?

Jak używać doxygen do tworzenia diagramów klas UML ze źródła C++

Szukałem materiału, który opisuje jak generować proste diagramy klas za pomocą doxygen, ale nie mogłem go znaleźć. Czy ktoś m ... diagramy jak pokazano poniżej z zestawu plików C++. Jeśli są lepsze narzędzia, aby to łatwiej osiągnąć, proszę dać mi znać.

Gdzie umieścić bloki komentarzy doxygen dla wewnętrznej biblioteki-w plikach H lub CPP? [zamknięte]

Zdrowy rozsądek mówi, że bloki komentarzy Doxygen muszą być umieszczone w plikach nagłówkowych, gdzie znajdują się klasy, str ... tarzy Nie znajdują się w plikach nagłówkowych, w których znajdują się deklaracje. Więc, co myślisz i ewentualnie sugerujesz?

Jak udokumentować Kod Pythona za pomocą doxygen [zamknięty]

Lubię doxygen tworzyć dokumentację kodu C lub PHP. Mam nadchodzący projekt Pythona i myślę, że pamiętam, że Python nie ma Kom ... aznajomiony z doxygen, Jak mogę go użyć do stworzenia dokumentacji Pythona? Czy jest coś szczególnego, o czym muszę wiedzieć?

Jak publikować strony na Githubie od Travis CI?

Kompilujemy dokumenty Doxygen na serwerze travis-ci i chcemy je wypchnąć na naszą gałąź gh-pages. Jak obsługiwać autoryzację ... ush? Czy ktoś ma Przykład użycia zaszyfrowanych zmiennych w travis-ci? Czy powinienem wybrać autoryzację https czy klucz SSH?

Doxygen vs Javadoc [closed]

Właśnie zrozumiałem z artykułu w CACM, że Doxygen działa również z Javą (i kilkoma innymi językami). Ale Java ma już Narzędzi ... Czy ktoś może wyjaśnić jakie są plusy i minusy obu podejść? Czy wzajemnie się wykluczają? Czy jest wtyczka Maven do Doxygen?

Jak włączyć opis metody Doxygen w wyskakującym oknie autocomplete Xcode?

Używając Xcode, chcę mieć Opis Doxygen mojej metody pod opcją autouzupełniania, jak alloc: Podczas pisania Xcode wyświetla ... ane wyniki w pliku HTML, który generuje Doxygen, ale nie wiem, jak sprawić, by te wyniki pojawiały się jako sugestie w Xcode.

Jak załączyć pliki niestandardowe w Doxygen

Chciałbym dodać niestandardowe (nie-projektowe) pliki do generowania dodatkowych stron z Doxygen . Jestem (faktycznie) pewien, jak te pliki powinny być nazwane i jak ich zawartość powinna być sformatowana.

Jak uzyskać pojedynczy dokument PDF z Doxygen?

Kiedy generuję dokumentację Doxygen w formacie PDF, dostaję wiele różnych plików z jednym diagramem w każdym. Czy jest możliw ... jako wersja HTML? Czy jest możliwe, aby uzyskać go automatycznie, tzn. bez czynienia ręcznie z plikami latex? Thank ' s!

Użyj README.md plik jako Strona główna w Doxygen

Dokumentacja Doxygen stwierdza, że mogę używać PHP Markdown extra title labelling w pliku markdown, ale ani # Main Page # { ... plik markdown jako część określonego języka? EDIT: włączyłem obsługę markdown, a plik pojawia się na powiązanych stronach.

Wtyczka Doxygen eclipse automatycznie generująca dokumentację Stuba? [zamknięte]

Szukam wtyczki eclipse do dokumentacji kodu doxygen. Znalazłem eclox-plugIn ( http://home.gna.org/eclox / ). Chciałbym się d ... int p1, int p2, ...), powinno wygenerować: /*! \brief ... \param p1 ... .. */ PS Używam głównie języków c / C++

Dokumentowanie kodu biblioteki C++/CLI do użycia z c# - najlepsze narzędzia i praktyki? [zamknięte]

Pracuję nad projektem, w którym biblioteka c++ / cli jest używana głównie z aplikacji c#. Czy jest jakiś sposób, aby komenta ... e użycie z c# (i oczywiście w c++/cli)? Jakie jest twoje zdanie na temat komentarzy XML vs doxygen vs Inne narzędzia (które)?

Czy Mogę mieć mój indeks stron Github.html w podfolderze repozytorium?

Próbuję użyć stron Github do hostowania strony Doxygen. Idealnie, chciałbym móc wypchnąć wygenerowane pliki i katalogi na Git ... o Strony Pages). Czy Jest jakiś sposób, aby Github rozpoznał ten indeks.html gdy jest w podfolderze? Jest to strona projektu.

Doxygen, zbyt ciężki do utrzymania? [zamknięte]

Obecnie zaczynam używać doxygen do dokumentowania kodu źródłowego. Zauważyłem, że składnia jest bardzo ciężka, za każdym raze ... nazwą parametru w nim na przykład) w kodzie źródłowym (szablon) dla każdej nowej pozycji PS: pracuję nad projektem C / C++.

Jaki jest Mathworks sposób na generowanie dokumentacji HTML Matlab?

Pracuję nad współdzielonym kodem Matlab i chcielibyśmy udostępnić wygenerowaną dokumentację jako przeszukiwalne dokumenty HTM ... ion_handle')); addRequired(p, 'analysisWindowHandle', validationFcn); parse(p, x, fftSize, fftShift, analysisWindowHandle);

Generowanie dokumentacji JavaScript za pomocą Doxygen

W moim projekcie używam PHP i JavaScript, które w całości koduję za pomocą netbeans 7.0.1. Bardzo podoba mi się, jak netbeans ... ktoś pokazał mi jak najlepiej połączyć dwa wyjścia doxygen i JsDoc w jedną dokumentację. Z góry wielkie dzięki! Pozdrawiam!