Skip to content

Class ReferenceWriter

Namespace: Apogee.Scripting
Assembly: Apogee.Scripting.dll

Writes the engine's Luau API as Markdown pages for the Manual (--luau-docs), from the same registry as : one page per class (classes/Name.md), one per script library (libraries/name.md), one for all enums (enums.md) and reference.md, which lists everything with the host's globals. The output depends only on the registry, in a fixed order, with \n line ends.

public static class ReferenceWriter

Inheritance

object ← ReferenceWriter

Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()

Methods

Write(DefinitionOptions?)

The pages of everything registered now, by path relative to the output folder (always with /).

public static IReadOnlyDictionary<string, string> Write(DefinitionOptions? options = null)

Parameters

options DefinitionOptions?

Returns

IReadOnlyDictionary<string, string>

Write(IReadOnlyList<ClassInfo>, IReadOnlyList<EnumInfo>, IReadOnlyList<LibraryInfo>, DefinitionOptions?)

public static IReadOnlyDictionary<string, string> Write(IReadOnlyList<ClassInfo> classes, IReadOnlyList<EnumInfo> enums, IReadOnlyList<LibraryInfo> libraries, DefinitionOptions? options = null)

Parameters

classes IReadOnlyList<ClassInfo>

enums IReadOnlyList<EnumInfo>

libraries IReadOnlyList<LibraryInfo>

options DefinitionOptions?

Returns

IReadOnlyDictionary<string, string>

WriteTo(string, DefinitionOptions?)

Writes the pages into directory, replacing the ones a previous run wrote there (and nothing else).

public static void WriteTo(string directory, DefinitionOptions? options = null)

Parameters

directory string

options DefinitionOptions?