Używanie automatycznej dokumentacji mojej własnej funkcji z Qt Creator?

Question

używałem Qt Creator i postanowiłem chciałem udokumentować funkcję Napisałem więc umieszczony mój kursor nad moją definicji funkcji i wpisane /**<ENTER> tak:

/**<ENTER> 
void MyClass::myFunction(int myArg) 
{ 
... 

Qt Creator automatycznie rozszerzony że komentarz:

/** 
* @brief MyClass::myFunction 
* @param myArg 
*/ 
void MyClass::myFunction(int myArg) 
{ 
... 

Co to jest? Gdzie jest to udokumentowane?

Czy mogę użyć tego do wygenerowania własnych plików pomocy Qt Assistant qch?

Answer 1

To powinno być udokumentowane here lub here, ale jej nie ...

Więc tutaj jest kilka informacji o tym:

Ustawienia dla tej funkcji można znaleźć tutaj:

Windows:

Kreator Qt> Narzędzia> Opcje> Edytor tekstu> Zakończenie> Dokumentacja Komentarze

Mac OS X:

Qt Creator> Preferencje> Edytor tekstu> Zakończenie> Dokumentacja Komentarze

trzech opcji Wymienia są:

• Włącz bloki doxygen
• Wygeneruj krótki opis
• Dodaj wiodącą gwiazdkę

(Znalezione w Qt 2.6, ale być może w poprzednich wersjach, zbyt ?, albo może być częścią domyślnej wtyczki ustawiony w pewnym momencie.)

czopów, które są tworzone są doxygen stylu odcinki.

Możesz użyć doxygen, aby uruchomić kod źródłowy i utworzyć jakąś wymyślną dokumentację, zarówno w pliku chm, jak iw dokumencie HTML i pdf.

http://www.stack.nl/~dimitri/doxygen/

http://www.stack.nl/~dimitri/doxygen/manual/output.html (zawiera pliki Qch)

Oto powiązany plugin dla Qt Creator:

http://dev.kofee.org/projects/qtcreator-doxygen/wiki

I używając QHelpEngine w swoim własnym programie ...

http://qt-project.org/doc/qt-4.8/qthelp-framework.html

I wreszcie, można użyć QDesktopServices obsłużyć pomocy stylizowany adres:

http://doc-snapshot.qt-project.org/4.8/qdesktopservices.html#url-handlers

nadzieję, że pomoże.