Learn how easy it is to sync an existing GitHub or Google Code repo to a SourceForge project! See Demo

Close

How to link to function parameter definition

Support
2012-09-03
2012-09-14
  • I have defined a struct and a function that takes a pointer to the struct as a
    parameter:

    /*---------------------------------------------------------------------------
     * Struct: myStruct
     * This is my silly structure
     *
     * Members:
     * a  - The first integer.
     * b - The second integer.
     *---------------------------------------------------------------------------*/
    struct myStruct {
        int a;
        int b;
    };
    
    /*---------------------------------------------------------------------------
     * Function: myFunction
     * This is my silly function.
     *
     * Parameters:
     *   values       - The important values.
     *---------------------------------------------------------------------------*/
    void myFunction(struct myStruct *values);
    

    In the ND generated documentation I would like the "myStruct" part of the
    function definition to act as a link to the structure documentation part. I
    have not been able to figure out how to do this, nor if it is possible at all.

    I know I can do it in the parameter description section by using <>, but I
    would like ND to do this automatically since it already knows the struct
    definition.

    /Benny

     
  • Greg Valure
    Greg Valure
    2012-09-03

    This isn't possible in the current version. It's already implemented in 2.0
    but that hasn't been released yet.