[ET Trac] [Einstein Toolkit] #1268: Cross-references in reference manual should be easier

Einstein Toolkit trac-noreply at einsteintoolkit.org
Mon Feb 25 21:22:47 CST 2013


#1268: Cross-references in reference manual should be easier
-------------------------+--------------------------------------------------
 Reporter:  eschnett     |       Owner:     
     Type:  enhancement  |      Status:  new
 Priority:  major        |   Milestone:     
Component:  Cactus       |     Version:     
 Keywords:               |  
-------------------------+--------------------------------------------------
 The cross references in the reference manual look like:
 {{{
 \begin{SeeAlso2}{CCTK\_VError}{CCTK-VError}
 prints an error message with a variable argument list
 \end{SeeAlso2}
 }}}

 This is cumbersome, because the function description needs to be repeated.
 Instead, a simple pointer to the function should suffice. If this is not
 possible directly in latex, then we may want to use a different mechanism
 (e.g. Doxygen?).

-- 
Ticket URL: <https://trac.einsteintoolkit.org/ticket/1268>
Einstein Toolkit <http://einsteintoolkit.org>
The Einstein Toolkit


More information about the Trac mailing list