Class CodeDocsModule

Source code documentation module.

System.Object
FlaxEditor.Modules.EditorModule
CodeDocsModule
Namespace: FlaxEditor.Modules.SourceCodeEditing
Assembly: FlaxEngine.CSharp.dll
Syntax
public sealed class CodeDocsModule : EditorModule

Methods

GetTooltip(ScriptMemberInfo, Object[])

Gets the tooltip text for the type member.

Declaration
public string GetTooltip(ScriptMemberInfo member, object[] attributes = null)
Parameters
FlaxEditor.Scripting.ScriptMemberInfo member

The type member.
System.Object[] attributes

The member attributes. Optional, if null member attributes will be used.
Returns
System.String

The documentation tooltip.

GetTooltip(ScriptType, Object[])

Gets the tooltip text for the type.

Declaration
public string GetTooltip(ScriptType type, object[] attributes = null)
Parameters
FlaxEditor.Scripting.ScriptType type

The type.
System.Object[] attributes

The type attributes. Optional, if null type attributes will be used.
Returns
System.String

The documentation tooltip.

GetTooltip(Type, Object[])

Gets the tooltip text for the type.

Declaration
public string GetTooltip(Type type, object[] attributes = null)
Parameters
System.Type type

The type.
System.Object[] attributes

The type attributes. Optional, if null type attributes will be used.
Returns
System.String

The documentation tooltip.

GetTooltip(Type, String, Object[])

Gets the tooltip text for the type member.

Declaration
public string GetTooltip(Type type, string memberName, object[] attributes = null)
Parameters
System.Type type

The type.
System.String memberName

The member name.
System.Object[] attributes

The member attributes. Optional, if null member attributes will be used.
Returns
System.String

The documentation tooltip.

OnExit()

Declaration
public override void OnExit()
Overrides
FlaxEditor.Modules.EditorModule.OnExit()

OnInit()

Declaration
public override void OnInit()
Overrides
FlaxEditor.Modules.EditorModule.OnInit()

Extension Methods

See Also

FlaxEditor.Modules.EditorModule