Re: [Doxygen-users] C++ Namespace best practice

[<pro...@gm...>]

My own approach for the namespace's description is to put them in a specific file, like namespace.dox. I put it in a subdirectory DoxPages with the mainpage.dox and the other stuff that can't be put in a class's documentation, which include our KnowledgeBase pages, HowTo and the images we add. 

If you use the .dox extension, don't forget to edit the FILE_PATTERNS parameter to add it.

At 09:46:32 -0500 you wrote:
>From: "Paul Grodt" <pg...@te...>
>Subject: [Doxygen-users] C++ Namespace best practice
>To: <dox...@li...>
>
>Forgive me if the question has been asked or addressed before.  I've had
>miserable luck searching for the answer.  The closest I've found is this
>thread:
>http://sourceforge.net/mailarchive/message.php?msg_id=1CFE360F7FED6D46A1
>10BEF31F2F54FE8814DF%40JUPITER.Teraview.local
>
>My question is essentially the same.  According to the Manual on
>Doxygen, I must document each namespace, but it should be done only
>once, even though a namespace frequently spans multiple header and
>source files.  
>
>I'm responsible for rewriting my organization's coding standards
>document, and we've decided to switch to Doxygen style comments.  I
>realize it's possible to have any number of policies for documenting
>namespaces, but is there some preferred method or best practice on how
>to do this?  
>
>One possibility I see is adding a "@namespace" tag to a single file.
>Another would be adding a Doxygen comment before the namespace in the
>first (and only the first) file that happens to use it.  The former
>feels kind of ugly, and the latter feels kind of arbitrary.  Concerning
>the latter suggestion, since we'll be migrating existing code during the
>course of regular development, this makes it a bit annoying to check if
>a namespace has yet been provided with a proper Doxygen comment or not.
>
>Any recommendations or learned personal experience would be appreciated.
>
>Paul D. Grodt
> 
>TECORE Wireless Systems