This is a JavaScript declaration syntax generator that is used to add a JavaScript Syntax section to each generated API topic.

Namespace: SandcastleBuilder.Components
Assembly: SandcastleBuilder.Components (in SandcastleBuilder.Components.dll) Version: 1.9.3.0

Syntax

C#
public class JavaScriptDeclarationSyntaxGenerator : SyntaxGeneratorTemplate
Visual Basic
Public Class JavaScriptDeclarationSyntaxGenerator _
	Inherits SyntaxGeneratorTemplate

Remarks

This version differs from the ScriptSharpDeclarationSyntaxGenerator in that it looks for a <scriptSharp /> element in the <api> node and, if found, only then will it apply the casing rules to the member name. If not present, no casing rules are applied to the member names thus it is suitable for use with regular JavaScript such as that used in AjaxDoc projects.

Examples

In order to use this script generator, you should modify the Sandcastle transformation file FixScriptSharp.xsl by adding the following template as the second one in the file. The help file builder uses a modified version of the transformation so that you do not need to apply the change when using it.
CopyFixScriptSharp.xsl Patch
<!-- Add a "scriptSharp" element to each API node so that the
     JavaScript syntax generator will apply the casing rules to the
     member name. -->
<xsl:template match="api">
  <xsl:copy>
    <xsl:apply-templates select="node() | @*" />
    <scriptSharp />
  </xsl:copy>
</xsl:template>

Inheritance Hierarchy

System..::..Object
  Microsoft.Ddue.Tools..::..SyntaxGenerator
    Microsoft.Ddue.Tools..::..SyntaxGeneratorTemplate
      SandcastleBuilder.Components..::..JavaScriptDeclarationSyntaxGenerator

See Also