Download Autoduck Tags - Literate Programming
Transcript
// @flag 0 | If <p szStr1> and <p szStr2> are the same. int strcmp( char *szStr1, char *szStr2) // @parm Specifies a pointer to the first string. // @parm Specifies a pointer to the second string. Comments The type and name fields can both be omitted if the function declaration immediately follows the comment block in which the @func tag was used. Paragraph Tags @rdesc @parm @comm @ex @xref @flag See Also @cb @globalv (paragraph-level) The @globalv tag is used to document global variables and is generally used inside an @module topic. Syntax @globalv type name description Example The following example shows the @globalv tag: /* @doc DKOALA * * @module DKOALA.CPP - Koala Object DLL Chapter 4 | * * Example object implemented in a DLL. This object supports * IUnknown and IPersist interfaces, meaning it doesn't know * anything more than how to return its class ID, but it * demonstrates a component object in a DLL. * * Copyright (c)1993 Microsoft Corporation, All Rights Reserved * * @index | DKOALA * * @normal Kraig Brockschmidt, Software Design Engineer * Microsoft Systems Developer Relations * * Autoduck example by Eric Artzt ([email protected]) */ //Do this once in the entire build #define INITGUIDS #include "dkoala.h" //@globalv Count number of objects ULONG g_cObj=0;