JavaScriptDeclarationSyntaxGenerator Class
This is a JavaScript declaration syntax generator that is used to add a JavaScript Syntax section to
each generated API topic.
Namespace: Sandcastle.Tools.SyntaxGeneratorsAssembly: Sandcastle.Tools.SyntaxGenerators (in Sandcastle.Tools.SyntaxGenerators.dll) Version: 2024.12.21.0
public sealed class JavaScriptDeclarationSyntaxGenerator : SyntaxGeneratorTemplate
Public NotInheritable Class JavaScriptDeclarationSyntaxGenerator
Inherits SyntaxGeneratorTemplate
public ref class JavaScriptDeclarationSyntaxGenerator sealed : public SyntaxGeneratorTemplate
[<SealedAttribute>]
type JavaScriptDeclarationSyntaxGenerator =
class
inherit SyntaxGeneratorTemplate
end
- Inheritance
- Object SyntaxGeneratorCore SyntaxGeneratorTemplate JavaScriptDeclarationSyntaxGenerator
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.
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
GetHashCode | Serves as the default hash function. (Inherited from Object) |
GetType | Gets the Type of the current instance. (Inherited from Object) |
Initialize |
Initialize the syntax generator
(Inherited from SyntaxGeneratorTemplate) |
ToString | Returns a string that represents the current object. (Inherited from Object) |
WriteAttachedEventSyntax |
Not used by this syntax generator
(Overrides SyntaxGeneratorTemplateWriteAttachedEventSyntax(XPathNavigator, SyntaxWriter)) |
WriteAttachedPropertySyntax |
Write out attached property syntax
(Overrides SyntaxGeneratorTemplateWriteAttachedPropertySyntax(XPathNavigator, SyntaxWriter)) |
WriteCastSyntax |
Cast syntax is unsupported
(Overrides SyntaxGeneratorTemplateWriteCastSyntax(XPathNavigator, SyntaxWriter)) |
WriteClassSyntax |
Write out class syntax
(Overrides SyntaxGeneratorTemplateWriteClassSyntax(XPathNavigator, SyntaxWriter)) |
WriteConstructorSyntax |
Write out constructor syntax
(Overrides SyntaxGeneratorTemplateWriteConstructorSyntax(XPathNavigator, SyntaxWriter)) |
WriteDelegateSyntax |
Write out delegate syntax
(Overrides SyntaxGeneratorTemplateWriteDelegateSyntax(XPathNavigator, SyntaxWriter)) |
WriteEnumerationSyntax |
Write out enumeration syntax
(Overrides SyntaxGeneratorTemplateWriteEnumerationSyntax(XPathNavigator, SyntaxWriter)) |
WriteEventSyntax |
Write out event syntax
(Overrides SyntaxGeneratorTemplateWriteEventSyntax(XPathNavigator, SyntaxWriter)) |
WriteFieldSyntax |
Write out field syntax
(Overrides SyntaxGeneratorTemplateWriteFieldSyntax(XPathNavigator, SyntaxWriter)) |
WriteInterfaceSyntax |
Write out interface syntax
(Overrides SyntaxGeneratorTemplateWriteInterfaceSyntax(XPathNavigator, SyntaxWriter)) |
WriteMemberSyntax |
Write member syntax
(Inherited from SyntaxGeneratorTemplate) |
WriteMethodSyntax |
Write method syntax
(Inherited from SyntaxGeneratorTemplate) |
WriteNamespaceSyntax |
Write out namespace syntax
(Overrides SyntaxGeneratorTemplateWriteNamespaceSyntax(XPathNavigator, SyntaxWriter)) |
WriteNormalMethodSyntax |
Write out normal method syntax
(Overrides SyntaxGeneratorTemplateWriteNormalMethodSyntax(XPathNavigator, SyntaxWriter)) |
WriteOperatorSyntax |
Operator syntax is unsupported
(Overrides SyntaxGeneratorTemplateWriteOperatorSyntax(XPathNavigator, SyntaxWriter)) |
WritePropertySyntax |
Write out property syntax if supported
(Overrides SyntaxGeneratorTemplateWritePropertySyntax(XPathNavigator, SyntaxWriter)) |
WriteStructureSyntax |
Structure syntax is unsupported
(Overrides SyntaxGeneratorTemplateWriteStructureSyntax(XPathNavigator, SyntaxWriter)) |
WriteSyntax |
This is the main syntax writing method
(Inherited from SyntaxGeneratorTemplate) |
WriteTypeSyntax |
Write type syntax
(Inherited from SyntaxGeneratorTemplate) |