Re: [Xenomai-help] doc patch: RT_TASK_INFO

[Nathaniel Villaume <villaume@domain.hid>]

The patches were to help you out! I thought that maybe you wouldn't want 
RT_TASK documented -- users don't really need to konw about magic number 
and flowgen, do they?  But yeah, sorry for the spamming.

As for the comment style, the C style comments don't show up using this 
inline method: /*!< */   -- that was part of the original problem.  One 
solution is to use the @typedef command. The only drawback here is the 
minor replication. For example:

/*! @typedef RT_TASK
    @brief Contains important data
  @param  magic  Magic uniquely identifies the task's wizardry ancestry
  @param  prio   task priority
*/
typedef struct {
  int magic;  // Must come first!   (comments don't HAVE to go here)
  uint prio;  // task priority
  /* etc */
} RT_TASK;

What I need to know from you:
1) Do you care about this duplication of struct member-names (harder to 
keep docs synchronized with code)?
2) Do you want RT_TASK member documentation to show up in 
doxygen-generated pages?  (this lets me know what to change)

-Nate