Table of Contents

JavaScriptDeclarationSyntaxGenerator Class

Definition

Namespace
Sandcastle.Tools.SyntaxGenerators
Assembly
Sandcastle.Tools.SyntaxGenerators.dll

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

public sealed class JavaScriptDeclarationSyntaxGenerator : SyntaxGeneratorTemplate
Inheritance
JavaScriptDeclarationSyntaxGenerator

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.

In order to use this script generator with Script# content, the Sandcastle reflection data file must first be transformed using the Script# Reflection File Fixer plug-in so that the necessary changes are made to it.

Properties

Language

This is used to get or set the language name

(Inherited from SyntaxGeneratorTemplate)
StyleId

This is used to get or set the style ID

(Inherited from SyntaxGeneratorTemplate)

Methods

WriteAttachedEventSyntax(XPathNavigator, SyntaxWriter)

Not used by this syntax generator

WriteAttachedPropertySyntax(XPathNavigator, SyntaxWriter)

Write out attached property syntax

WriteCastSyntax(XPathNavigator, SyntaxWriter)

Cast syntax is unsupported

WriteClassSyntax(XPathNavigator, SyntaxWriter)

Write out class syntax

WriteConstructorSyntax(XPathNavigator, SyntaxWriter)

Write out constructor syntax

WriteDelegateSyntax(XPathNavigator, SyntaxWriter)

Write out delegate syntax

WriteEnumerationSyntax(XPathNavigator, SyntaxWriter)

Write out enumeration syntax

WriteEventSyntax(XPathNavigator, SyntaxWriter)

Write out event syntax

WriteFieldSyntax(XPathNavigator, SyntaxWriter)

Write out field syntax

WriteInterfaceSyntax(XPathNavigator, SyntaxWriter)

Write out interface syntax

WriteNamespaceSyntax(XPathNavigator, SyntaxWriter)

Write out namespace syntax

WriteNormalMethodSyntax(XPathNavigator, SyntaxWriter)

Write out normal method syntax

WriteNormalTypeReference(string, SyntaxWriter)

Write out a normal type reference

WriteOperatorSyntax(XPathNavigator, SyntaxWriter)

Operator syntax is unsupported

WritePropertySyntax(XPathNavigator, SyntaxWriter)

Write out property syntax if supported

WriteStructureSyntax(XPathNavigator, SyntaxWriter)

Structure syntax is unsupported

WriteTypeReference(XPathNavigator, SyntaxWriter)

Write out a type reference