From faa402fcdae902209e8446987fcdaada06bd23b6 Mon Sep 17 00:00:00 2001 From: zadam Date: Thu, 29 Jun 2023 20:54:58 +0200 Subject: [PATCH] API docs --- docs/backend_api/AbstractBeccaEntity.html | 213 +- docs/backend_api/BAttribute.html | 225 +- docs/backend_api/BBranch.html | 333 ++- docs/backend_api/BEtapiToken.html | 221 +- docs/backend_api/BNote.html | 1990 ++++++++++++--- docs/backend_api/BNoteRevision.html | 2183 ----------------- docs/backend_api/BOption.html | 221 +- docs/backend_api/BRecentNote.html | 221 +- docs/backend_api/BackendScriptApi.html | 6 +- ...cca_entities_abstract_becca_entity.js.html | 136 +- .../becca_entities_battribute.js.html | 14 +- .../becca_entities_bbranch.js.html | 13 +- .../becca_entities_betapi_token.js.html | 2 +- docs/backend_api/becca_entities_bnote.js.html | 475 ++-- .../becca_entities_bnote_revision.js.html | 244 -- .../becca_entities_boption.js.html | 2 +- .../becca_entities_brecent_note.js.html | 2 +- docs/backend_api/index.html | 2 +- docs/backend_api/module-sql.html | 2 +- .../services_backend_script_api.js.html | 6 +- docs/backend_api/services_sql.js.html | 2 +- docs/frontend_api/FAttribute.html | 6 +- docs/frontend_api/FBranch.html | 6 +- docs/frontend_api/FNote.html | 581 ++++- docs/frontend_api/FNoteComplement.html | 790 ------ docs/frontend_api/FrontendScriptApi.html | 197 +- docs/frontend_api/entities_fattribute.js.html | 4 +- docs/frontend_api/entities_fbranch.js.html | 4 +- docs/frontend_api/entities_fnote.js.html | 99 +- .../entities_fnote_complement.js.html | 91 - docs/frontend_api/index.html | 2 +- .../services_frontend_script_api.js.html | 47 +- 32 files changed, 4286 insertions(+), 4054 deletions(-) delete mode 100644 docs/backend_api/BNoteRevision.html delete mode 100644 docs/backend_api/becca_entities_bnote_revision.js.html delete mode 100644 docs/frontend_api/FNoteComplement.html delete mode 100644 docs/frontend_api/entities_fnote_complement.js.html diff --git a/docs/backend_api/AbstractBeccaEntity.html b/docs/backend_api/AbstractBeccaEntity.html index 328d08f0c..117d2d80b 100644 --- a/docs/backend_api/AbstractBeccaEntity.html +++ b/docs/backend_api/AbstractBeccaEntity.html @@ -93,7 +93,7 @@
Source:
@@ -183,7 +183,7 @@
Source:
@@ -205,6 +205,195 @@

Methods

+ + + + + + +

(protected) _getContent() → {string|Buffer}

+ + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string +| + +Buffer + + +
+
+ + + + + + + + + + + + + +

(protected) _setContent()

+ + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + @@ -259,7 +448,7 @@
Source:
@@ -343,7 +532,7 @@
Source:
@@ -427,7 +616,7 @@
Source:
@@ -511,7 +700,7 @@
Source:
@@ -595,7 +784,7 @@
Source:
@@ -679,7 +868,7 @@
Source:
@@ -725,7 +914,7 @@
Mark the entity as (soft) deleted. It will be completely erased later. -This is a low level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead. +This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
@@ -833,7 +1022,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
Source:
@@ -921,7 +1110,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
Source:
@@ -985,7 +1174,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
diff --git a/docs/backend_api/BAttribute.html b/docs/backend_api/BAttribute.html index 29eb98f90..8c693765f 100644 --- a/docs/backend_api/BAttribute.html +++ b/docs/backend_api/BAttribute.html @@ -268,7 +268,7 @@ and relation (representing named relationship between source and target note)Source:
@@ -490,7 +490,7 @@ and relation (representing named relationship between source and target note)position :int +

position :integer

@@ -501,7 +501,7 @@ and relation (representing named relationship between source and target note)
  • -int +integer
    • @@ -766,6 +766,205 @@ and relation (representing named relationship between source and target note)Methods + + + + + + +

    (protected) _getContent() → {string|Buffer}

    + + + + + + + + + + + + + + + + + + +
    + + + + + + + + +
    Overrides:
    +
    + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    Returns:
    + + + + +
    +
    + Type +
    +
    + +string +| + +Buffer + + +
    +
    + + + + + + + + + + + + + +

    (protected) _setContent()

    + + + + + + + + + + + + + + + + + + +
    + + + + + + + + +
    Overrides:
    +
    + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + + + + + + + +
    + + + + + + + + + + + + + + + + + + + + @@ -825,7 +1024,7 @@ and relation (representing named relationship between source and target note)Source:
    @@ -914,7 +1113,7 @@ and relation (representing named relationship between source and target note)Source:
    @@ -1003,7 +1202,7 @@ and relation (representing named relationship between source and target note)Source:
    @@ -1092,7 +1291,7 @@ and relation (representing named relationship between source and target note)Source:
    @@ -1286,7 +1485,7 @@ and relation (representing named relationship between source and target note)Source:
    @@ -1480,7 +1679,7 @@ and relation (representing named relationship between source and target note)Source:
    @@ -1628,7 +1827,7 @@ and relation (representing named relationship between source and target note) Mark the entity as (soft) deleted. It will be completely erased later. -This is a low level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead. +This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead. @@ -1741,7 +1940,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
    Source:
    @@ -1834,7 +2033,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
    Source:
    @@ -1898,7 +2097,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
    diff --git a/docs/backend_api/BBranch.html b/docs/backend_api/BBranch.html index f75738ee7..b1aca3eff 100644 --- a/docs/backend_api/BBranch.html +++ b/docs/backend_api/BBranch.html @@ -203,7 +203,7 @@ Always check noteId instead.
    Source:
    @@ -463,7 +463,7 @@ of deletion should not act as a clone.
    Source:
    @@ -549,7 +549,7 @@ of deletion should not act as a clone. -

    notePosition :int

    +

    notePosition :integer

    @@ -560,7 +560,7 @@ of deletion should not act as a clone.