yade-dev team mailing list archive

Thread
Date

[Bug 398190] Re: make doxygen reference more useful

To: yade-dev@xxxxxxxxxxxxxxxxxxx
From: Václav Šmilauer <eudoxos@xxxxxxxx>
Date: Fri, 05 Mar 2010 08:10:03 -0000
Reply-to: Bug 398190 <398190@xxxxxxxxxxxxxxxxxx>
Sender: bounces@xxxxxxxxxxxxx

Marked invalid since it is sphinx documentation that we use now. (Unless
we want to use doxygen to document the internals, but I doubt it would
be useful)

** Changed in: yade
       Status: New => Invalid

-- 
make doxygen reference more useful
https://bugs.launchpad.net/bugs/398190
You received this bug notification because you are a member of Yade
developers, which is subscribed to Yade.

Status in Yet Another Dynamic Engine: Invalid

Bug description:
This entails: 

1. making the class hierarchy easier to read (e.g. exclude "EngineUnit2D< void, TYPELIST_3(const shared_ptr< PhysicalParameters > &, const shared_ptr< PhysicalParameters > &, const shared_ptr< Interaction > &) >" or Indexable et Serializable from inheritance hierarchy etc.)

2. writing at least brief documentation for most classes.

3. excluding non-yade things from doxygen (think sqlite and other 3rd party libs)