View Single Post
Old 11-21-2011, 10:11 AM   #10
sergeyvl12
ebook fan
sergeyvl12 ought to be getting tired of karma fortunes by now.sergeyvl12 ought to be getting tired of karma fortunes by now.sergeyvl12 ought to be getting tired of karma fortunes by now.sergeyvl12 ought to be getting tired of karma fortunes by now.sergeyvl12 ought to be getting tired of karma fortunes by now.sergeyvl12 ought to be getting tired of karma fortunes by now.sergeyvl12 ought to be getting tired of karma fortunes by now.sergeyvl12 ought to be getting tired of karma fortunes by now.sergeyvl12 ought to be getting tired of karma fortunes by now.sergeyvl12 ought to be getting tired of karma fortunes by now.sergeyvl12 ought to be getting tired of karma fortunes by now.
 
Posts: 735
Karma: 2528718
Join Date: Dec 2010
Device: PocketBook 301+, Kindle 3 Wi-Fi, Onyx Boox A62, Kindle Touch
Quote:
Originally Posted by MartinZ View Post
That's not "my" format, but I follow the syntax given by Doxygen.

Doxygen let's us steer the documentation, that it generates from the .h-file.
I meant "commenting style". There are several "styles" in doxygen.

I saw that your style is "//!". My style was "/*!"

I've converted all to "//!".

Quote:
Originally Posted by MartinZ View Post
But you could suggest, which set of doxygen comments we should use and which one we should avoid, to get a homogen and smooth documentation-style.
"//!"

Quote:
Originally Posted by MartinZ View Post
by the way:
shouldn't it read "\brief" and not "\breaf" ?
Thanks! fixed.

BTW. I've updated my pbsdk site. Now it refers to documentation. But documentation main page is empty!

http://pbsdk.vlasovsoft.net/html/index.html

We should add something to the main page...

Last edited by sergeyvl12; 11-21-2011 at 10:16 AM.
sergeyvl12 is offline   Reply With Quote