[ext] improved engraving api docs

Author: igorkorsukov

share/extensions/apitests/macros.js

@@ -17,6 +17,8 @@ function main()
         , "Engraving.Element.MEASURE:", Engraving.Element.MEASURE
     )
 
+    console.log("measure.hideWhenEmpty:", measure.hideWhenEmpty)
+
     if (measure.type === Element.MEASURE) {
         console.log("this is measure")
         Interactive.info("Macros", "This is a measure.")

src/engraving/api/v1/apitypes.h

@@ -527,13 +527,23 @@ enum class TextPlace {
 };
 Q_ENUM_NS(TextPlace);
 
+/** APIDOC
+ * Direction
+ * @memberof Engraving
+ * @enum
+ */
 enum class Direction {
     AUTO = int(mu::engraving::DirectionV::AUTO),
     UP   = int(mu::engraving::DirectionV::UP),
     DOWN = int(mu::engraving::DirectionV::DOWN),
 };
 Q_ENUM_NS(Direction);
 
+/** APIDOC
+ * Horizontal direction
+ * @memberof Engraving
+ * @enum
+ */
 enum class DirectionH {
     AUTO  = int(mu::engraving::DirectionH::AUTO),
     LEFT  = int(mu::engraving::DirectionH::LEFT),
@@ -547,6 +557,11 @@ enum class Orientation {
 };
 Q_ENUM_NS(Orientation);
 
+/** APIDOC
+ * Auto-hide flag
+ * @memberof Engraving
+ * @enum
+ */
 enum class AutoOnOff {
     AUTO = int(mu::engraving::AutoOnOff::AUTO),
     ON   = int(mu::engraving::AutoOnOff::ON),
@@ -699,6 +714,11 @@ enum class PreferSharpFlat {
 };
 Q_ENUM_NS(PreferSharpFlat);
 
+/** APIDOC
+ * Type of note head
+ * @memberof Engraving
+ * @enum
+ */
 enum class NoteHeadType {
     HEAD_AUTO    = int(mu::engraving::NoteHeadType::HEAD_AUTO),
     HEAD_WHOLE   = int(mu::engraving::NoteHeadType::HEAD_WHOLE),
@@ -724,6 +744,11 @@ enum class NoteHeadScheme {
 };
 Q_ENUM_NS(NoteHeadScheme);
 
+/** APIDOC
+ * Group of note head
+ * @memberof Engraving
+ * @enum
+ */
 enum class NoteHeadGroup {
     HEAD_NORMAL          = int(mu::engraving::NoteHeadGroup::HEAD_NORMAL),
     HEAD_CROSS           = int(mu::engraving::NoteHeadGroup::HEAD_CROSS),
@@ -1116,6 +1141,11 @@ enum class HookType {
 };
 Q_ENUM_NS(HookType);
 
+/** APIDOC
+ * Mode of key
+ * @memberof Engraving
+ * @enum
+ */
 enum class KeyMode {
     UNKNOWN    = int(mu::engraving::KeyMode::UNKNOWN),
     NONE       = int(mu::engraving::KeyMode::NONE),
@@ -1301,6 +1331,11 @@ enum class ChordLineType {
 };
 Q_ENUM_NS(ChordLineType);
 
+/** APIDOC
+ * Type of slur
+ * @memberof Engraving
+ * @enum
+ */
 enum class SlurStyleType {
     Undefined  = int(mu::engraving::SlurStyleType::Undefined),
     Solid      = int(mu::engraving::SlurStyleType::Solid),