cxxFunctionAPIItemLocation

Describes the location of a function in the original C++ source code.

Description

Describes the location of a function in the original C++ source code.

Example

Given this code in inc/a.h:

/**
@param aBuf The buffer
*/
void g(const char* aBuf=0);
            

And this code in src/a.cpp:

#include "a.h"

void g(const char* aBuffer)
{
	// Implementation
}
            

Then function g would have the cxxFunctionAPIItemLocation element:

<cxxFunctionAPIItemLocation>
  <cxxFunctionDeclarationFile name="filePath" value="inc/a.h"/>
  <cxxFunctionDeclarationFileLine name="lineNumber" value="5"/>
  <cxxFunctionDefinitionFile name="filePath" value="src/a.cpp"/>
  <cxxFunctionDefinitionFileLineStart name="lineNumber" value="4"/>
  <cxxFunctionDefinitionFileLineEnd name="lineNumber" value="7"/>
</cxxFunctionAPIItemLocation>
            

Contained by

cxxFunctionDefinition

Contains

cxxFunctionDeclarationFile cxxFunctionDeclarationFileLine cxxFunctionDefinitionFile cxxFunctionDefinitionFileLineEnd cxxFunctionDefinitionFileLineStart

Content Model

(cxxFunctionDeclarationFile then cxxFunctionDeclarationFileLine then cxxFunctionDefinitionFile (optional) then cxxFunctionDefinitionFileLineStart (optional) then cxxFunctionDefinitionFileLineEnd (optional) )

Inheritance

topic/ph reference/ph apiRef/apiDefItem apiOperation/apiDefItem cxxFunction/cxxFunctionAPIItemLocation