Yade

make doxygen reference more useful

Bug #398190 reported by Václav Šmilauer
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Yade
Invalid
Undecided
Unassigned

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)

Revision history for this message
Václav Šmilauer (eudoxos) wrote :

http://beta.arcig.cz/~eudoxos/yade/doxygen/ will contain weekly refreshed doxygen docs.

Revision history for this message
Václav Šmilauer (eudoxos) wrote :

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
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.
Subscribing...

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.