Documentation

📊 Overview: 2 Properties

1 Constructor

17 Functions

📝 Description

This.CompiledClassesObject:=This.getCompiledClassesObject($CompileCode)

🕐 Last updated: 2025-11-14T16:53:00.442Z

---

📑 Table of Contents

• 📋 Properties (2)
• 🏗️ Constructor (1 param)
• ⚙️ Functions
  • Regular Functions
    • generateClassDocumentation
    • getCompiledClassesObject (1 param) → Object
    • generateTableDocumentation (1 param)
    • generateAllClassJSON
    • generateMarkdownFromJSON
    • _generateMarkdownForClass (1 param) → Text
    • _generateFunctionMarkdown (1 param) → Text
    • _generateGetterSetterQueryOrderByMarkdown (4 params) → Text
    • generateAllTableJSON
    • generateMarkdownFromTableJSON
    • _generateMarkdownForTable (1 param) → Text
    • generateAllFormJSON
    • discoverRelationships → Integer
    • generateMarkdownFromFormJSON
    • _generateMarkdownForForm (1 param) → Text
    • _getObjectTypeEmoji (1 param) → Text
    • getClassJsonCollection → $ClassJsonCollection : Collection

---

Properties

Property	Type	Default	Description
CompiledClassesObject	Object	-	-
ClassesJsonFolder	Not specified	Folder("/PACKAGE/Documentation/Classes/")	-

Constructor

constructor

[🏗️ constructor]

Class constructor($CompileCode : Boolean)

This.generateClassDocumentation()

Parameters:

Name	Type	Optional	Description
$CompileCode	Boolean	-	-

---

Functions

Regular Functions

generateClassDocumentation

Function generateClassDocumentation

---

getCompiledClassesObject

Function getCompiledClassesObject($CompileCode : Boolean) -> Object

Parameters:

Name	Type	Optional	Description
$CompileCode	Boolean	-	-

Returns: Object

---

generateTableDocumentation

Function generateTableDocumentation($DataClass : 4D.DataClass)

Parameters:

Name	Type	Optional	Description
$DataClass	4D.DataClass	-	-

---

generateAllClassJSON

Function generateAllClassJSON

Generate JSON files for all classes using ClassInspector

---

generateMarkdownFromJSON

Function generateMarkdownFromJSON

Generate markdown documentation from JSON files

---

_generateMarkdownForClass

Function _generateMarkdownForClass($ClassJSON : Object) -> Text

Helper function to generate markdown for a single class

Parameters:

Name	Type	Optional	Description
$ClassJSON	Object	-	-

Returns: Text

---

_generateFunctionMarkdown

Function _generateFunctionMarkdown($Func : Object) -> Text

Helper function to generate markdown for a single function

Parameters:

Name	Type	Optional	Description
$Func	Object	-	-

Returns: Text

---

_generateGetterSetterQueryOrderByMarkdown

Function _generateGetterSetterQueryOrderByMarkdown($GetterFunc : Object; $SetterFunc : Object; $QueryFunc : Object; $OrderByFunc : Object) -> Text

Generate combined getter/setter/query/orderBy markdown

Parameters:

Name	Type	Optional	Description
$GetterFunc	Object	-	-
$SetterFunc	Object	-	-
$QueryFunc	Object	-	-
$OrderByFunc	Object	-	-

Returns: Text

---

generateAllTableJSON

Function generateAllTableJSON

Get all table names from the catalog

---

generateMarkdownFromTableJSON

Function generateMarkdownFromTableJSON

Generate markdown documentation from table JSON files

---

_generateMarkdownForTable

Function _generateMarkdownForTable($TableJSON : Object) -> Text

Helper function to generate markdown for a single table

Parameters:

Name	Type	Optional	Description
$TableJSON	Object	-	-

Returns: Text

---

generateAllFormJSON

Function generateAllFormJSON

Generate JSON files for all forms using FormInspector

---

discoverRelationships

Function discoverRelationships -> Integer

Discover and update relationships between Forms, Tables, and Classes

Returns: Integer

---

generateMarkdownFromFormJSON

Function generateMarkdownFromFormJSON

Generate markdown documentation from form JSON files

---

_generateMarkdownForForm

Function _generateMarkdownForForm($FormJSON : Object) -> Text

Helper function to generate markdown for a single form

Parameters:

Name	Type	Optional	Description
$FormJSON	Object	-	-

Returns: Text

---

_getObjectTypeEmoji

Function _getObjectTypeEmoji($ObjectType : Text) -> Text

Get emoji for object type

Parameters:

Name	Type	Optional	Description
$ObjectType	Text	-	-

Returns: Text

---

getClassJsonCollection

Function getClassJsonCollection -> $ClassJsonCollection : Collection

Returns: Collection

---

---

Generated from Documentation.4dm