Fixes using updated docs generator

trevordevore · Nov 5, 2018 · c8d5857 · c8d5857
1 parent 1652d6a
commit c8d5857
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 692 deletions.
diff --git a/framework/helpers/broadcaster/README.md b/framework/helpers/broadcaster/README.md
@@ -71,7 +71,6 @@ end UpdateUIWithDefaultTextSize
 - [broadcasterListenForBroadcasts](#broadcasterListenForBroadcasts)
 - [broadcasterStopListeningForBroadcasts](#broadcasterStopListeningForBroadcasts)
 
-
 <br>
 
 ## <a name="broadcasterBroadcast"></a>broadcasterBroadcast

diff --git a/framework/helpers/file_system/README.md b/framework/helpers/file_system/README.md
@@ -325,7 +325,6 @@ The helper does not currently provide an API for working with security scoped fi
 - [ProcessCommandLineParameters](#ProcessCommandLineParameters)
 - [urlWakeUp](#urlWakeUp)
 
-
 <br>
 
 ## <a name="appleEvent"></a>appleEvent

diff --git a/framework/helpers/logger/README.md b/framework/helpers/logger/README.md
@@ -124,209 +124,9 @@ The [`loggerOpenLogMonitor`](#loggerOpenLogMonitor) command will open a palette
 - [loggerSetNetworkTrafficFilters](#loggerSetNetworkTrafficFilters)
 - [loggerSetTarget](#loggerSetTarget)
 - [loggerSetTypes](#loggerSetTypes)
-- [loggerAddType](#loggerAddType)
-- [loggerGetNetworkTrafficFilters](#loggerGetNetworkTrafficFilters)
-- [loggerGetTarget](#loggerGetTarget)
-- [loggerGetTypes](#loggerGetTypes)
-- [loggerLogMsg](#loggerLogMsg)
->
-- [loggerOpenLogMonitor](#loggerOpenLogMonitor)
-- [loggerRemoveType](#loggerRemoveType)
-- [loggerSetNetworkTrafficFilters](#loggerSetNetworkTrafficFilters)
-- [loggerSetTarget](#loggerSetTarget)
-- [loggerSetTypes](#loggerSetTypes
-
-
-<br>
-
-## <a name="loggerAddType"></a>loggerAddType
-
-**Type**: command
-
-**Syntax**: `loggerAddType <pType>`
-
-**Summary**: Start logging a specific message type.
-
-**Returns**: Empty
-
-**Parameters**:
-
-| Name | Description |
-|:---- |:----------- |
-| `pType` |  `developer`, `network`, `msg`, `extensions`. |
-
-<br>
-
-## <a name="loggerGetNetworkTrafficFilters"></a>loggerGetNetworkTrafficFilters
-
-**Type**: function
-
-**Syntax**: `loggerGetNetworkTrafficFilters()`
-
-**Summary**: Returns the list of filters that are being applied to libURL messages.
-
-<br>
-
-## <a name="loggerGetTarget"></a>loggerGetTarget
-
-**Type**: function
-
-**Syntax**: `loggerGetTarget()`
-
-**Summary**: Returns the current target where log messages are sent.
-
-**Returns**: empty, `console`, `<filename>`, or field reference
-
-<br>
-
-## <a name="loggerGetTypes"></a>loggerGetTypes
-
-**Type**: function
-
-**Syntax**: `loggerGetTypes()`
-
-**Summary**: Returns the types of messages that are being logged.
-
-**Returns**: Comma-delimited list
-
-<br>
-
-## <a name="loggerLogMsg"></a>loggerLogMsg
-
-**Type**: command
-
-**Syntax**: `loggerLogMsg <pMsg>`
-
-**Summary**: Logs a message. The message is of type `developer`.
-
-**Returns**: Error message
-
-**Parameters**:
-
-| Name | Description |
-|:---- |:----------- |
-| `pMsg` |  The message to log. |
 
 <br>
 
-## <a name="loggerOpenLogMonitor"></a>loggerOpenLogMonitor
-
-**Type**: command
-
-**Syntax**: `loggerOpenLogMonitor `
-
-**Summary**: Opens a palette stack that displays log messages.
-
-**Returns**: Empty
-
-**Description**:
-
-Use the log monitor to aid in debugging. It can be used in the IDE or in a standalone. For
-example, if you want to open the logger whenever running a `test` standalone add the following
-script to `InitializeApplication`:
-
-```
-command InitializeApplication
-  if levureBuildProfile() is "test" then
-    loggerOpenLogMonitor
-  end if
-
-  #...
-InitializeApplication
-```
-
-<br>
-
-## <a name="loggerRemoveType"></a>loggerRemoveType
-
-**Type**: command
-
-**Syntax**: `loggerRemoveType <pType>`
-
-**Summary**: Stop logging a specific message type.
-
-**Returns**: Empty
-
-**Parameters**:
-
-| Name | Description |
-|:---- |:----------- |
-| `pType` |  `developer`, `network`, `msg`, `extensions`. |
-
-<br>
-
-## <a name="loggerSetNetworkTrafficFilters"></a>loggerSetNetworkTrafficFilters
-
-**Type**: command
-
-**Syntax**: `loggerSetNetworkTrafficFilters <pFilters>`
-
-**Summary**: Registers regex filters that will be applied to libURL messages that are logged.
-
-**Returns**: Empty
-
-**Parameters**:
-
-| Name | Description |
-|:---- |:----------- |
-| `pFilters` |  A CR-delimited list of filters to apply to libURL messages. Each line is a tab-delimited list where item 1 is a regex pattern and item 2 is the value to use as a replacement. |
-
-**Description**:
-
-You can set network traffic log filters to remove sensitive data from logs that you generate.
-
-<br>
-
-## <a name="loggerSetTarget"></a>loggerSetTarget
-
-**Type**: command
-
-**Syntax**: `loggerSetTarget <pTarget>`
-
-**Summary**: Sets the field where log messages will be sent.
-
-**Returns**: Empty
-
-**Parameters**:
-
-| Name | Description |
-|:---- |:----------- |
-| `pTarget` |  `console`, `<filename>`, or field reference (e.g. `<the long id field>`). |
-
-**Description**:
-
-You can target the "console", a file, or a field. "console" writes the log message to `stdout`.
-
-<br>
-
-## <a name="loggerSetTypes"></a>loggerSetTypes
-
-**Type**: command
-
-**Syntax**: `loggerSetTypes <pTypes>`
-
-**Summary**: Set the type of messages to log.
-
-**Returns**: Empty
-
-**Parameters**:
-
-| Name | Description |
-|:---- |:----------- |
-| `pTypes` |  A comma-delimited list of types to log. |
-
-**Description**:
-
-Use this command to filter the types of messages that are logged.
-
-`all` : All currently supported message types.
-`developer`: Any message logged using `loggerLogMsg`.
-`network`: Messages logged by libURL.
-`msg`: Any `put` statements that do not have a target. E.g. `put "testing"`
-`extensions`: Messages logged by an extension using the `log` command in LiveCode Builder.
-
-
-
 ## <a name="loggerAddType"></a>loggerAddType
 
 **Type**: command

diff --git a/framework/helpers/preferences/README.md b/framework/helpers/preferences/README.md
@@ -134,7 +134,6 @@ Levure will automatically call `prefsSave` when your application is running as a
 - [prefsSave](#prefsSave)
 - [prefsSetPref](#prefsSetPref)
 
-
 <br>
 
 ## <a name="prefsGetDefaults"></a>prefsGetDefaults

diff --git a/framework/helpers/undo_manager/README.md b/framework/helpers/undo_manager/README.md
@@ -227,30 +227,28 @@ When undoing changes in a field the `textChanged` message is sent for each memen
 
 - [undoRestoreMementos](#undoRestoreMementos)
 - [undoStoreMementos](#undoStoreMementos)
-- [undoRestoreMementos](#undoRestoreMementos)
-- [undoStoreMementos](#undoStoreMementos)- [undoAddAction](#undoAddAction)
+- [undoAddAction](#undoAddAction)
 - [undoCanRedo](#undoCanRedo)
 - [undoCanUndo](#undoCanUndo)
+>
 - [undoCleanupStack](#undoCleanupStack)
 - [undoGetMaxUndos](#undoGetMaxUndos)
->
 - [undoGetNextUndoInStack](#undoGetNextUndoInStack)
 - [undoGetTargetForStackCallbacks](#undoGetTargetForStackCallbacks)
 - [undoPrintLog](#undoPrintLog)
+>
 - [undoRedo](#undoRedo)
 - [undoRedoActionName](#undoRedoActionName)
->
 - [undoRegisterEditFieldType](#undoRegisterEditFieldType)
 - [undoRegisterType](#undoRegisterType)
 - [undoRemoveLatest](#undoRemoveLatest)
+>
 - [undoReset](#undoReset)
 - [undoSetMaxUndos](#undoSetMaxUndos)
->
 - [undoSetTargetForStackCallbacks](#undoSetTargetForStackCallbacks)
 - [undoUndo](#undoUndo)
 - [undoUndoActionName](#undoUndoActionName)
 
-
 <br>
 
 ## <a name="undoRestoreMementos"></a>undoRestoreMementos
@@ -275,26 +273,8 @@ When undoing changes in a field the `textChanged` message is sent for each memen
 
 
 
-## <a name="undoRestoreMementos"></a>undoRestoreMementos
-
-**Type**: command
-
-**Syntax**: `undoRestoreMementos <pUndoStack>,<pMementosA>`
-
-**Summary**: Restores mementos for a field edit.
-
-
 <br>
 
-## <a name="undoStoreMementos"></a>undoStoreMementos
-
-**Type**: command
-
-**Syntax**: `undoStoreMementos <pUndoStack>,<pMementosA>`
-
-**Summary**: Stores a memento for a field prior to changes being made.
-
-
 ## <a name="undoAddAction"></a>undoAddAction
 
 **Type**: command