cidentifiers.xml

这是一个能够自动生成文档的程序

<?xml version="1.0" encoding="GB2312" ?>
<class name="CIdentifiers">
	<explain>管理符号表，所有需要用于符号查询的符号均统一保存在此类的对象中，
以便一次性查询，包括：
1. 关键字，包括基本数据类型
2. 宏扩展，在完成预处理后删除
3. enum
4. 类，结构，接口
5. 函数：包括所有函数
6. 变量：包括全局变量和类成员变量
所有符号首先保存到CIdneItem类的对象中，然后将其对象指针保存到列表中
</explain>
	<function name="CIdentifiers">
		<prototype index="1">CIdentifiers();</prototype>
		<desc>构造函数
</desc>
		<explain>构造函数
</explain>
	</function>
	<function name="~CIdentifiers">
		<prototype index="1">virtual ~CIdentifiers();</prototype>
		<desc>析构函数
</desc>
		<explain>析构函数
</explain>
	</function>
	<function name="Init">
		<prototype index="1">void Init();</prototype>
		<desc>初始化，在解析一个项目的代码前，要首先将符号表初始...</desc>
		<explain>初始化，在解析一个项目的代码前，要首先将符号表初始化
</explain>
	</function>
	<function name="ClearContent">
		<prototype index="1">void ClearContent();</prototype>
		<desc>清除全部标识符
</desc>
		<explain>清除全部标识符
</explain>
	</function>
	<function name="AddIdentifier">
		<prototype index="1">BOOL AddIdentifier(LPCTSTR iName,UINT iType=ID_UNDEFINED,CIdentifier* ipIden=NULL,KEYWORD iKeyIndex=KEY_NOT);</prototype>
		<desc>加入Item，函数一用于加入关键字、宏定义等没有域限制...</desc>
		<explain>加入Item，函数一用于加入关键字、宏定义等没有域限制的标识符
函数二用于加入类，函数，变量等有域限制的标识符
其中，变量和函数均可以声明和定义分另加入，加入时合并
函数还可以加入重载函数，加入时合并
返回TRUE表示普通加入，参数中的ipIden指针仍然是有效指针
返回FALSE表示合并加入，参数中的ipIden指针所指对象已被删除
</explain>
		<prototype index="2">BOOL AddIdentifier(LPCTSTR iName,UINT iType,CIdentifier* ipIden,LPCTSTR iScope);</prototype>
	</function>
	<function name="DeleteIdentifier">
		<prototype index="1">void DeleteIdentifier(LPCTSTR iName);</prototype>
		<desc>根据名称删除一个标识符
</desc>
		<explain>根据名称删除一个标识符
</explain>
	</function>
	<function name="AddGlobalMacro">
		<prototype index="1">void AddGlobalMacro(LPCTSTR iMacros);</prototype>
		<desc>设定全局宏，多个宏用;分隔
</desc>
		<explain>设定全局宏，多个宏用;分隔
</explain>
	</function>
	<function name="QueryKeyword">
		<prototype index="1">KEYWORD QueryKeyword(LPCTSTR);</prototype>
		<desc>查询标识符是否关键字，是则返回关键字编号，否则返回...</desc>
		<explain>查询标识符是否关键字，是则返回关键字编号，否则返回KEY_NOT
</explain>
	</function>
	<function name="IsDefinedMacro">
		<prototype index="1">BOOL IsDefinedMacro(LPCTSTR iName,CPage* ipPage=NULL);</prototype>
		<desc>查询标识符是否是已定义的宏
</desc>
		<explain>查询标识符是否是已定义的宏
</explain>
	</function>
	<function name="UnwindMacro">
		<prototype index="1">CIdenItem* UnwindMacro(LPCTSTR iWord,CPage* ipPage,CTokenList&amp; ioList,POSITION&amp; ioPos);</prototype>
		<desc>判断标识符是否是宏，如是，则展开，即将宏名删除，替...</desc>
		<explain>判断标识符是否是宏，如是，则展开，即将宏名删除，替换为展开后的Token，返回Item指针。
对于其他标识符，返回Item指针。未定义的标识符返回NULL
iWord为标识符，ipPage为标识符所在的代码页
</explain>
	</function>
	<function name="Search">
		<prototype index="1">CIdenItem* Search(LPCTSTR iName);</prototype>
		<desc>查询一个标识符项，如不存在，返回NULL
</desc>
		<explain>查询一个标识符项，如不存在，返回NULL
</explain>
	</function>
</class>