Mam projekt, w którym używam Doxygen do generowania dokumentacji. Dokumentacja zajęć jest w porządku, ale mam także kilka funkcji, których używam w main() do tworzenia obiektów itp. Chciałbym również je włączyć do mojej dokumentacji, ale nie miałem pojęcia, jak to zrobić. Jakieś sugestie?Dokumentowanie funkcji w C++ przy użyciu Doxygen
Odpowiedz
Zastosowanie \fn
gdzie można inaczej wykorzystać \class
w \\*!
*\
bloku
http://www.doxygen.nl/docblocks.html
szukać "Dokumentacja w innych miejscach"
http://www.doxygen.nl/commands.html#cmdfn
To działa podobnie jak dokumentowanie funkcje składowe
ten wzór działał dobrze dla nas.
/*! Convert counts to kg for the reservoir.
\param counts The A/D counts to convert.`
\return The calculated kg based on the parameter.
*/
float RES_ConvertCountsToValue(uint_16 counts);
Lubię ten wzór
///////////////////////////////////////////////////////////////////////
/// \brief setX
/// \param x offset of the image.
/// \return a new image as an QImage.
/////////////////////////////////////////////////////////////////////////
QImage setX(int x);
podmioty, które są członkami klas są udokumentowane tylko jeśli ich klasa jest udokumentowane. Elementy zadeklarowane w zasięgu obszaru nazw są udokumentowane tylko wtedy, gdy ich przestrzeń nazw jest udokumentowana. Encje zadeklarowane w zasięgu pliku są udokumentowane tylko wtedy, gdy ich plik jest udokumentowany.
więc udokumentować bezpłatną funkcję w globalnej przestrzeni nazw trzeba też taką linię gdzieś w pliku nagłówka, w którym została zadeklarowana:
/** @file */
Albo jak ten:
/*! \file */
- 1. Doxygen C++ - Nie dokumentowanie funkcji wirtualnych w klasie szablonu
- 2. Dokumentowanie zmienne z Doxygen w C
- 3. Dokumentowanie wartości enum z doxygen
- 4. Dokumentowanie fabryk przy użyciu JSDoc
- 5. C++ przy użyciu funkcji przekazanej
- 6. Dokumentowanie funkcji ustawiających z roxygenem
- 7. Dokumentowanie parametrów Get/Post za pomocą Doxygen lub PHPDoc
- 8. Ustawianie atrybutów pliku przy użyciu natywnych funkcji C/C++
- 9. Kopiuj przy użyciu funkcji udostępnionej
- 10. doxygen C++ inline szablon dokumentacji
- 11. Test jednostki debugowania w języku C przy użyciu funkcji sprawdzania
- 12. wezwanie C++ przy użyciu funkcji Eigen biblioteki w python
- 13. Jak używać funkcji C# w Java przy użyciu JNA lib
- 14. listę klas według katalogu/katalogu przy użyciu doxygen?
- 15. Błąd przy użyciu funkcji solvePnPRansac
- 16. Doxygen C++ parser ciąg znaków w python?
- 17. Generowanie funkcji Call-Graph Doxygen + Graphviz
- 18. wywołania funkcji przy użyciu nazw
- 19. wywołania funkcji przy użyciu nohup
- 20. przy użyciu samodzielnej funkcji szałwii w pytonie
- 21. C, jak utworzyć wątek przy użyciu funkcji pthread_create
- 22. C# przy użyciu funkcji sendKey wysłać klucz do innej aplikacji
- 23. SOAP przy użyciu C#
- 24. wywoływanie funkcji java z c przy użyciu jni
- 25. Zwiększenie :: python Ujawnianie funkcji C++ przy użyciu i zwracaniu szablonów
- 26. Tworzenie Inputbox w C# przy użyciu formularzy
- 27. Doxygen: wielokrotne \ mainpage bloki w C++ projektu
- 28. Dokumentacja parametrów funkcji doxygen (//! <Vs @param)
- 29. Doxygen powtarzające funkcje C++ z domyślnymi argumentami
- 30. Dokumentowanie kodu C lub C++ za pomocą nowychb i LaTeX