added property support for api doc

Author: igorkorsukov

src/engraving/api/v1/elements.h

@@ -2356,17 +2356,22 @@ class Tie : public Spanner
     /// \endcond
 };
 
+/** APIDOC
+ * Class representing a lyric.
+ * @class Lyric
+ * @hideconstructor
+*/
 class Lyric : public EngravingItem
 {
     Q_OBJECT
-
     Q_PROPERTY(QString plainText READ plainText)
 
 public:
 
     Lyric(mu::engraving::Lyrics* l = nullptr, Ownership own = Ownership::PLUGIN)
         : EngravingItem(l, own) {}
 
+    /** APIDOC @property {string} - plain text of lyric */
     QString plainText() const { return toLyrics(e)->plainText(); }
 };
 

src/engraving/api/v1/score.cpp

@@ -39,6 +39,18 @@
 
 using namespace mu::engraving::apiv1;
 
+/** APIDOC
+ * Class representing a score.
+ * We can get the current score by calling the `api.engraving.curScore`
+ * @class Score
+ * @hideconstructor
+*/
+
+/** APIDOC
+ * Create a new Cursor
+ * @method
+ * @returns {Cursor} cursor
+*/
 Cursor* Score::newCursor()
 {
     return new Cursor(score());
@@ -262,12 +274,35 @@ QQmlListProperty<System> Score::systems()
     return wrapContainerProperty<System>(this, score()->systems());
 }
 
-QQmlListProperty<Lyric> Score::lyrics()
+/** APIDOC @property {boolean} - has lyrics */
+bool Score::hasLyrics() const
+{
+    return score()->hasLyrics();
+}
+
+/** APIDOC @property {number} - count of lyrics */
+int Score::lyricCount() const
+{
+    return score()->lyricCount();
+}
+
+/** APIDOC @property {Lyric[]} - list of lyrics */
+QQmlListProperty<Lyric> Score::lyrics() const
 {
     static std::vector<Lyrics*> list = score()->lyrics();
     return wrapContainerProperty<Lyric>(this, list);
 }
 
+/** APIDOC
+* Extracts all lyrics in the score and returns them in a single string.
+* @method
+* @return {string} - lyrics string
+*/
+QString Score::extractLyrics() const
+{
+    return score()->extractLyrics();
+}
+
 //---------------------------------------------------------
 //   Score::startCmd
 //---------------------------------------------------------

src/engraving/api/v1/score.h

@@ -273,11 +273,10 @@ class Score : public apiv1::ScoreElement, public muse::Injectable
     Q_INVOKABLE apiv1::Segment* findSegmentAtTick(int types, apiv1::FractionWrapper* tick);
 
     // === Lyrics ===
-    bool hasLyrics() { return score()->hasLyrics(); }
-    int lyricCount() { return score()->lyricCount(); }
-    QQmlListProperty<apiv1::Lyric> lyrics();
-    /// Extracts all lyrics in the score and returns them in a single string.
-    Q_INVOKABLE QString extractLyrics() { return score()->extractLyrics(); }
+    bool hasLyrics() const;
+    int lyricCount() const;
+    QQmlListProperty<apiv1::Lyric> lyrics() const;
+    Q_INVOKABLE QString extractLyrics() const;
 
     /// \cond MS_INTERNAL
     int nmeasures() const { return static_cast<int>(score()->nmeasures()); }

src/engraving/api/v1/scoreelement.h

@@ -183,8 +183,8 @@ class QmlListAccess : public QQmlListProperty<T>
 
 /// \cond PLUGIN_API \private \endcond
 template<typename T, class Container>
-QmlListAccess<T, Container> wrapContainerProperty(QObject* obj, Container& c)
+QmlListAccess<T, Container> wrapContainerProperty(const QObject* obj, Container& c)
 {
-    return QmlListAccess<T, Container>(obj, c);
+    return QmlListAccess<T, Container>(const_cast<QObject*>(obj), c);
 }
 }

src/engraving/dom/score.cpp

@@ -4995,7 +4995,7 @@ ChordRest* Score::cmdTopStaff(ChordRest* cr)
 //   hasLyrics
 //---------------------------------------------------------
 
-bool Score::hasLyrics()
+bool Score::hasLyrics() const
 {
     if (!firstMeasure()) {
         return false;
@@ -5017,7 +5017,7 @@ bool Score::hasLyrics()
 //   hasHarmonies
 //---------------------------------------------------------
 
-bool Score::hasHarmonies()
+bool Score::hasHarmonies() const
 {
     if (!firstMeasure()) {
         return false;
@@ -5117,7 +5117,7 @@ std::vector<Lyrics*> Score::lyrics() const
 //   extractLyrics
 //---------------------------------------------------------
 
-String Score::extractLyrics()
+String Score::extractLyrics() const
 {
     String result;
     std::vector<Lyrics*> list = lyrics();
@@ -5133,12 +5133,11 @@ String Score::extractLyrics()
     return result.trimmed();
 }
 
-
 //---------------------------------------------------------
 //   harmonyCount
 //---------------------------------------------------------
 
-int Score::harmonyCount()
+int Score::harmonyCount() const
 {
     int count = 0;
     SegmentType st = SegmentType::ChordRest;
@@ -5152,7 +5151,6 @@ int Score::harmonyCount()
     return count;
 }
 
-
 //---------------------------------------------------------
 //   keysig
 //---------------------------------------------------------

src/engraving/dom/score.h

@@ -990,12 +990,15 @@ class Score : public EngravingObject, public muse::Injectable
     EngravingItem* lastElement(bool frame = true);
 
     size_t nmeasures() const;
-    bool hasLyrics();
-    bool hasHarmonies();
+
+    bool hasHarmonies() const;
+    int harmonyCount() const;
+
+    bool hasLyrics() const;
     int  lyricCount() const;
     std::vector<Lyrics*> lyrics() const;
-    int  harmonyCount();
-    String extractLyrics();
+    String extractLyrics() const;
+
     int keysig();
     int duration();
     int durationWithoutRepeats();

src/framework/global/api/interactiveapi.cpp

@@ -25,18 +25,19 @@
 
 using namespace muse::api;
 
-/** APIDOC namespace: interactive
+/** APIDOC
  * User interaction - informational messages, error messages, questions and other dialogs.
- * @namespace
+ * @namespace interactive
  */
 
 InteractiveApi::InteractiveApi(IApiEngine* e)
     : ApiObject(e)
 {
 }
 
-/** APIDOC method
+/** APIDOC
  * Show information message
+ * @method
  * @param {String} title Title
  * @param {String} text Message
  */
@@ -46,8 +47,9 @@ void InteractiveApi::info(const QString& contentTitle, const QString& text)
     interactive()->infoSync(contentTitle.toStdString(), text.toStdString());
 }
 
-/** APIDOC method
+/** APIDOC
  * Open URL in external browser
+ * @method
  * @param {String} url URL
  */
 void InteractiveApi::openUrl(const QString& url)

src/framework/global/api/logapi.cpp

@@ -25,53 +25,58 @@
 
 using namespace muse::api;
 
-/** APIDOC namespace: log
+/** APIDOC
  * Write messages to log and console
- * @namespace
+ * @namespace log
  */
 LogApi::LogApi(api::IApiEngine* e)
     : ApiObject(e)
 {
 }
 
-/** APIDOC method
+/** APIDOC
  * Write error message with default tag
+ * @method
  * @param {String} message Message
  */
 void LogApi::error(const QString& message)
 {
     error("Api", message);
 }
 
-/** APIDOC method
+/** APIDOC
  * Write warning message with default tag
+ * @method
  * @param {String} message Message
  */
 void LogApi::warn(const QString& message)
 {
     warn("Api", message);
 }
 
-/** APIDOC method
+/** APIDOC
  * Write info message with default tag
+ * @method
  * @param {String} message Message
  */
 void LogApi::info(const QString& message)
 {
     info("Api", message);
 }
 
-/** APIDOC method
+/** APIDOC
  * Write debug message with default tag
+ * @method
  * @param {String} message Message
  */
 void LogApi::debug(const QString& message)
 {
     debug("Api", message);
 }
 
-/** APIDOC method
+/** APIDOC
  * Write error message with tag
+ * @method
  * @param {String} tag Tag
  * @param {String} message Message
  */
@@ -80,8 +85,9 @@ void LogApi::error(const QString& tag, const QString& message)
     LOGE_T(tag.toStdString())() << message;
 }
 
-/** APIDOC method
+/** APIDOC
  * Write warning message with tag
+ * @method
  * @param {String} tag Tag
  * @param {String} message Message
  */
@@ -90,8 +96,9 @@ void LogApi::warn(const QString& tag, const QString& message)
     LOGW_T(tag.toStdString())() << message;
 }
 
-/** APIDOC method
+/** APIDOC
  * Write info message with tag
+ * @method
  * @param {String} tag Tag
  * @param {String} message Message
  */
@@ -100,8 +107,9 @@ void LogApi::info(const QString& tag, const QString& message)
     LOGI_T(tag.toStdString())() << message;
 }
 
-/** APIDOC method
+/** APIDOC
  * Write debug message with tag
+ * @method
  * @param {String} tag Tag
  * @param {String} message Message
  */

tools/jsdoc/.gitignore

@@ -1,5 +1,4 @@
 node_modules
-package.json
 package-lock.json
 out
 gen_apidocsrc