SourceToolsInterface Class Reference

#include <sourcetools.h>

Detailed Description

An interface that provides tools to analyze Dox pages and code snippets.

Static Public Member Functions
static MAXON_METHOD Result< Bool >	SearchDoxLinkIssues (const BaseArray< DoxPage > &doxPages, BaseArray< Issue > &issues)
static MAXON_METHOD Result< Bool >	SearchBrokenSnippetRefs (const BaseArray< DoxPage > &doxPages, const BaseArray< CodeSnippet > &codeSnippets, BaseArray< Issue > &issues)
static MAXON_METHOD Result< Bool >	SearchSnippetIssues (const BaseArray< CodeSnippet > &codeSnippets, const SnippetSettings &settings, BaseArray< Issue > &issues)
static MAXON_METHOD Result< Bool >	SeachDoxPageTextIssues (const BaseArray< DoxPage > &doxPages, BaseArray< Issue > &issues)

Private Member Functions
	MAXON_INTERFACE_NONVIRTUAL (SourceToolsInterface, MAXON_REFERENCE_NONE, "net.sdktools.interfaces.sourcetools")

Member Function Documentation

MAXON_INTERFACE_NONVIRTUAL()

MAXON_INTERFACE_NONVIRTUAL ( SourceToolsInterface  , MAXON_REFERENCE_NONE  , "net.sdktools.interfaces.sourcetools"    )

private

SearchDoxLinkIssues()

static MAXON_METHOD Result<Bool> SearchDoxLinkIssues ( const BaseArray< DoxPage > &  doxPages, BaseArray< Issue > &  issues  )

static

Searches for any issue with the or links in Dox pages. Warning: Executes code in parallel.

Parameters

[in]	doxPages	The DoxPages to analyse.
[out]	issues	An array of issues found.

Returns

True if any issues were found.

SearchBrokenSnippetRefs()

static MAXON_METHOD Result<Bool> SearchBrokenSnippetRefs ( const BaseArray< DoxPage > &  doxPages, const BaseArray< CodeSnippet > &  codeSnippets, BaseArray< Issue > &  issues  )

static

Searches for broken

Parameters

[in]	doxPages	The DoxPages to analyse.
[in]	codeSnippets	The known code snippets.
[out]	issues	An array of issues found.

Returns

True if any issues were found.

SearchSnippetIssues()

static MAXON_METHOD Result<Bool> SearchSnippetIssues ( const BaseArray< CodeSnippet > &  codeSnippets, const SnippetSettings &  settings, BaseArray< Issue > &  issues  )

static

Checks the the code snippets. Checks min. length Checks max. length CheckDoubleWords() CheckSpaceAtEnd() Checks if the snippet has at least one comment Checks if the snippet starts with a comment Checks max. line-nesting Checks max. code-nesting depth Checks max. line length GetCyclomaticComplexity() GetIfStatementComplexity()

Parameters

[in]	codeSnippets	The code snippets to analyse.
[in]	settings	The settings to use.
[out]	issues	The issues found.

Returns

True if any issues were found.

SeachDoxPageTextIssues()

static MAXON_METHOD Result<Bool> SeachDoxPageTextIssues ( const BaseArray< DoxPage > &  doxPages, BaseArray< Issue > &  issues  )

static

Checks the text of the given Dox pages. Checks for: CheckDoubleWords() CheckSpaceAtEnd()

Parameters

[in]	doxPages	The Dox pages to analyse.
[out]	issues	The issues found.

Returns

True if any issues were found.