Hello I don't know enough about rootcint to say if a workaround is possible there. Depending on how you have Doxygen configured, though, a quick fix is to use the other methods Doxygen will recognize: int a; ///< JavaDoc style... int b; /**< JavaDoc style... */ int c; /*! Qt style... */ or put the documentation block before the member, although that's more annoying. Happy coding, Brant Carlson On Mon, 18 Aug 2003 12:54:44 -0500 (EST) "Mark D. Messier" <messier@indiana.edu> wrote: > > Hi, > > I'd like to post a quick warning about the use of the doxygen '//!<' > comment tag in files processed by rootcint. > > I'm working on a project which uses doxygen for automatic source code > documentation. One common tag used by doxygen for commenting member > variables is: > > class MyClass { > private: > float fFloat; //!< doxygen comment for fFloat... > }; > > Note, however, that rootcint uses this comment style (more exactly //!) to > flag member variables that should not be streamed to output. So a side > effect of the above doxygen comment is that the variable fFloat is not > saved if objects of type MyClass are streamed to an output file. > > I don't know if its possible to work around this in rootcint (perhaps > checking for comment strings which match ('//! ') or that match '//!' but > not '//!<' ??). A work around might be valuable as it seems doxygen is > becoming more and more widely used by software projects. > > In any case, I thought I'd post this to the list hoping that it saves > someone else some time debugging in the future. > > Cheers, > Mark > -- > Mark Messier e-mail: messier@indiana.edu > Department of Physics http://www.physics.indiana.edu/~messier > Indiana University Phone: (812) 855-0236 > Bloomington, IN 47405 Fax: (812) 855-0440 > > >
This archive was generated by hypermail 2b29 : Thu Jan 01 2004 - 17:50:14 MET