Download Autoduck Tags - Literate Programming
Transcript
Syntax @comm comments Example The following example shows the @comm tag: // @comm Makes a <c CRect> equal to the intersection of two // existing rectangles. The intersection is the largest rectangle // contained in both existing rectangles. See Also @todo @devnote @const (topic-level) The @const tag is a topic tag used to document c++ constants. Syntax @const type | name | description Example The following example shows the @const tag: // @const int | iArraySize | Maximum array size. You can also omit the type and name, provided the comment immediately precedes the constant declaration: // @const Maximum array size. const int iArraySize; @consumes (paragraph-level) The @consumes tag lists OLE interfaces consumed by an object. The tag is used within an @object topic block. Syntax @consumes list of interface names Example The following example shows @consumes within an @object topic block: // // // // // // // // @object IgorToolPoolObjServer | This is the MS provided content object for the tool pool. It is responsible for maintaining all the lists associated with all the tool pool entries - both groups and actual elements. @supint ISpecifyPropertyPages | Property page support @supint <i IToolPoolEntry> | The means to actually edit the