Work at SourceForge, help us to make it a better place! We have an immediate need for a Support Technician in our San Francisco or Denver office.

Close

#52 Autogenerated see clause obscures property docs

closed
nobody
5
2006-01-17
2006-01-16
No

If I write the documentation for a property like this:

<pre>
{* List of transformers to apply when reading
values. Used only if
@ref UseStandardTransformers returns True or if
@ref csoUseStandardTransformers is given in the
options passed to
the read operation.
}
property StandardReadTransformers: string read
FStandardReadTransformers write
FStandardReadTransformers;
</pre>

...I expect that documentation to show up attached to
the field "StandardReadTransformers". However, the
generated C++ is:

<pre>
/** List of transformers to apply when reading
values. Used only if
@ref UseStandardTransformers returns True or if
@ref csoUseStandardTransformers is given in the
options passed to
the read operation.
*/
/** \sa FStandardReadTransformers For reading
\sa FStandardReadTransformers For writing */
string StandardReadTransformers;
</pre>

The automatically generated \sa command for the
property setter and getter obscures the actual
documentation (Doxygen only processes the second
clause).

Discussion

  • Darren Bowles
    Darren Bowles
    2006-01-17

    • status: open --> closed
     
  • Darren Bowles
    Darren Bowles
    2006-01-17

    Logged In: YES
    user_id=73730

    I have added a -s command line option that will suppress
    generation of \sa comments for property statement.