Boost logo

Boost :

Subject: [boost] [tweener] Doxygen documentation issues
From: Julien Jorge (julien.jorge_at_[hidden])
Date: 2013-02-26 16:28:50


Hi,
        
I am writing the documentation of Boost.Tweener and I encounter various
difficulties. One of them is the generation of the class documentation
with doxygen. It seems that it cannot extract the class and member
documentation from .ipp files.
        
I like to document the methods of my classes near the implementation. In
Boost.Tweener, most of the class documentation is then in the .ipp files
and I have written the following lines in the Jamfile.v2:
        
  import quickbook ;
  using boostbook ;
          
  using doxygen ;
          
  doxygen reference
    :
      [ glob ../../../boost/tweener/*.hpp ]
      [ glob ../../../boost/tweener/detail/*.hpp ]
      [ glob ../../../boost/tweener/detail/impl/*.ipp ]
      [ glob ../../../boost/tweener/detail/impl/easing/*.ipp ]
      [ glob ../../../boost/tweener/easing/*.hpp ]
        
But when I try to build the documentation, I have the following error:
        
  boost_1_52_0/tools/build/v2/build/generators.jam:1085: in ensure-type
    from module generators
  error: target
    { ../../../boost/tweener/detail/impl/tweener_group.ipp. }
    has no type
        
Moreover, if I remove the ipp files, the generation of the documentation
does not fail but the doxygen documentation is not extracted, except for
the private members. So, how can I also disable the extraction of the
private members in the documentation?
        
You can check the Jamfile.v2 in the git repository of the project:

http://libclaw.git.sourceforge.net/git/gitweb.cgi?p=libclaw/boost-tweener;a=tree
        
Regards,
        
Julien
        


Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk