Feature request for IDE FPDoc Editor: document overloaded operators
Original Reporter info from Mantis: warrence
-
Reporter name: Stefan Müller
Original Reporter info from Mantis: warrence
- Reporter name: Stefan Müller
Description:
Currently there seems to be no possibility to enter or edit documentation of overloaded operators in FPDoc Editor, although fpdoc can handle this.
Additional information:
I'll provide an example. My operator is declared as
operator + (dp1: TPoint; dp2: TPoint) dps: TPoint;
The corresponding part of the description file would look like
<element name="operator +(TPoint, TPoint): TPoint">
<short>Componentwise sum of two vectors</short>
<descr>And a descrption of course...</descr>
</element>
<element name="operator +(TPoint, TPoint): TPoint.dp1">
<short>Left argument, vector</short>
</element>
<element name="operator +(TPoint, TPoint): TPoint.dp2">
<short>Right argument, vector</short>
</element>
<element name="operator +(TPoint, TPoint): TPoint.Identifier dps">
<short>Operator result</short>
</element>
Mantis conversion info:
- Mantis ID: 14423