[prev in list] [next in list] [prev in thread] [next in thread] 

List:       doxygen-users
Subject:    Re: [Doxygen-users] Why duplicated document are in both .h and .cpp?
From:       Jake Colman <colman () ppllc ! com>
Date:       2012-08-17 13:13:20
Message-ID: 76ipchslu7.fsf () dev-d01 ! ppllc ! com
[Download RAW message or body]


It's your choice where to put the documentation.  If the documentation
appears immediately before the item being documented Doxygen will know
what is being documented.  Otherwise, you have to tell it.

For example:

1) If the documentation for a class appears in the .h file immediately
   before its declaration you do not need to use the \class command.

2) If the documentation for a function/method appears immediately before
   its implementation in a source file you do not need to use the \fn
   command.


>>>>> "PY" == Peng Yu <pengyu.ut@gmail.com> writes:

   PY> On Fri, Aug 17, 2012 at 3:22 AM, Jakob van Bethlehem
   PY> <j.s.van.bethlehem@astro.rug.nl> wrote:
   >> On 08/17/2012 04:47 AM, Peng Yu wrote:
   >>> Hi,
   >>> 
   >>> In doxygen source code, I see the following.
   >>> 
   >>> In filedef.h
   >>> 95 /*! Returns the name of the verbatim copy of this file (if any). */
   >>> 96     QCString includeName() const;
   >>> 
   >>> In filedef.cpp
   >>> 
   >>> 1555 /*! Returns the name of the verbatim copy of this file (if any). */
   >>> 1556 QCString FileDef::includeName() const
   >>> 
   >>> The document are the same. I'm wondering which one is redundant.
   >>> 
   >>> I try to keep only the document in the cpp file (in my package). But
   >>> it does not appear in the generated document. Is there a way to keep
   >>> the document of member function in the cpp file and still have the
   >>> generated document?
   >>> 
   >> 
   >> Hej Peng,
   >> 
   >> I don't think you should be looking at the source code if you want to
   >> control output. First you really should be having a good look at all the
   >> possible configuration options that Doxygen provides. For
   >> you particular problem, I personally don't really understand what you're
   >> trying to do. Maybe you can give a short example, and explain what you
   >> would like Doxygen to generate for that. When you are at
   >> it, please also mention the version you're using and what of output you're
   >> trying to create.

   PY> Hi Jakob,

   PY> I merely want to look for some examples on how to put the document in
   PY> *.cpp file but not in *.h file as I am not able to let doxygen to show
   PY> comment from *.cpp files. I have tried many options, but I still don't
   PY> find which option should be used in Doxyfile.

   PY> To look for possible solutions to the above question, I went ahead to
   PY> check the comments in doxygen source code. I surprisingly find the
   PY> same comment appear in both *.cpp and *.h files which seems weird to
   PY> me. So my second question is why duplicated comments need to put in
   PY> both *.cpp and *.h files.

   PY> Are my questions clear to you now?

   PY> -- 
   PY> Regards,
   PY> Peng

   PY> ------------------------------------------------------------------------------
   PY> Live Security Virtual Conference
   PY> Exclusive live event will cover all the ways today's security and 
   PY> threat landscape has changed and how IT managers can respond. Discussions 
   PY> will include endpoint security, mobile security and the latest in malware 
   PY> threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/

-- 
Jake Colman | Director, Software Development
Principia Partners LLC
101 West Elm Street | Conshohocken | PA 19428 | +1 (610) 755 9770
t: +1 (610) 755 9786 | c: +1 (610) 348 2788 | f: +1 (201) 221 8929
e: colman@ppllc.com | w: www.principiapartners.com
Credit technology innovation awards winner 2008, 2009 & 2010


------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
[prev in list] [next in list] [prev in thread] [next in thread]