[Doxygen-develop] Crosreferences
Brought to you by:
dimitri
From: <jan...@co...> - 2002-06-19 18:58:14
|
Hi Dimitri and all around I would like see possibility of arbitrary crosreferences added to the Doxygen. Idea is to have references to one place, and on that place to have also list of places referencing . This comes from article about traceability of requirements trough the design and source code (IEEE Software). The requirements have assigned labels (numbers) which are then mentioned in the source code comments. Changes in the requirements then can be accommodated easily. Command for this could be \xref and \xlabel. -------------------------------Begin Example---------------------- /** Requirement 234 All outgoing messages should have check sum. \xlabel req234 */ /** This function computes CRC... \xref req234 ... */ int check_sum( char *data) /** This function composes messages... \xref req234 ... */ int compose_message( ) ------------------------------- End Example ------------------------ -------------------------------Begin Example Output---------------------- All outgoing messages should have check sum. crosreferenced by : int check_sum( char *data) <- xref int compose_message( ) <- xref ... This function computes CRC... req234 <- xref ... This function composes messages... req234 <- xref ... ------------------------------- End Example Output------------------------ Thanks Jan |