David Regan - 2019-04-29

I am documenting an emmbeded C project. I have function prototypes which refer to a table of bit mask options
e.g.

/*
* Sets a debug switch to active.
* The disposition controls when the switch is applied
* and how long it exists for.
* @param hndl Pointer to @ref ProtocolSupportHandle object
* @param sw @ref DbgSwitchItem "Switch" to activate.
* @param disposition @ref dbg_disposition_table "Disposition" of the switch activation.
* @return @ref ProtocolError "Protocol Status Code"
/
ProtocolError_t ps_dbg_setDebugSwitch(ptrProtocolSupportHandle_t hndl, DbgSwitchItem_t sw, Dbg_Disposition_t disposition);

/**
* @defgroup dbg_tables Debug Common Tables
* @details Tables used by the Debug Support apis

Debug Disposition
Value Meaning
0 Inactive - Remove any existing forces for this item immediately.
+1 Immediate - Apply force now until power down unless used in combination.
+2 One Shot - Apply force at next power up until following power down.
+4 Permanent - Apply force at next power up on a permanent basis.
  • n.b. Immediate can be combined with One Shot OR Permanent.
  • One Shot CANNOT be combined with Permanent.
  • @see DbgDispositionMask

    /
    /* @}/ // End of dbg_tables doxygen module

My issue is where is the best place to put the table information? I have created it in it's own group but this is not what I really want as it appears in the left hand menu. I just want to refer to the table in multiple
prototypes without it existing as a separate module. I tried it without @defgroup and it was added to
the comments for the first prototype in my header file.