LoweBowe/MuseScore
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

improve builtin plugin documentation

Browse source 
reformatting, removing some comments that are irrelevant to plugin
framework in a way that DoxyGen should still find them, documenting the
enums and fully qualify all types that are specific to MuseScore,
This commit is contained in:
Joachim Schmitz 2014-05-16 13:44:32 +02:00
parent b509cad88f
commit 54ede6a1f6
48 changed files with 188 additions and 187 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
libmscore/accidental.h
View file

@ -40,10 +40,10 @@ struct SymElement {
//---------------------------------------------------------
// @@ Accidental
// @P hasBracket bool
// @P small bool
// @P acctype enum ACC_NONE, ACC_SHARP, ACC_FLAT, ACC_SHARP2, ACC_FLAT2, ACC_NATURAL, ... (read only)
// @P role enum ACC_AUTO, ACC_USER (read only)
// @P hasBracket bool
// @P small bool
// @P acctype Ms::Accidental::AccidentalType (ACC_NONE, ACC_SHARP, ACC_FLAT, ACC_SHARP2, ACC_FLAT2, ACC_NATURAL, ...) (read only)
// @P role Ms::Accidental::AccidentalRole (ACC_AUTO, ACC_USER) (read only)
//---------------------------------------------------------
class Accidental : public Element {
@ -147,7 +147,7 @@ class Accidental : public Element {
//---------------------------------------------------------
// @@ AccidentalBracket
/// used as icon in palette
//! used as icon in palette
//---------------------------------------------------------
class AccidentalBracket : public Compound {

4
libmscore/box.h
View file

@ -87,7 +87,7 @@ class Box : public MeasureBase {
//---------------------------------------------------------
// @@ HBox
/// horizontal frame
/// horizontal frame
//---------------------------------------------------------
class HBox : public Box {
@ -109,7 +109,7 @@ class HBox : public Box {
//---------------------------------------------------------
// @@ VBox
/// vertical frame
/// vertical frame
//---------------------------------------------------------
class VBox : public Box {

2
libmscore/breath.h
View file

@ -23,7 +23,7 @@ enum class SymId;
//---------------------------------------------------------
// @@ Breath
/// breathType() is index in symList
//! breathType() is index in symList
//---------------------------------------------------------
class Breath : public Element {

10
libmscore/chord.h
View file

@ -49,12 +49,12 @@ enum class PlayEventType : char {
//---------------------------------------------------------
// @@ Chord
/// Graphic representation of a chord.
/// Single notes are handled as degenerated chords.
/// Graphic representation of a chord.
/// Single notes are handled as degenerated chords.
//
// @P notes array[Note] the list of notes (read only)
// @P lyrics array[Lyrics] the list of lyrics (read only)
// @P graceNotes array[Chord] the list of grace note chords (read only)
// @P notes array[Ms::Note] the list of notes (read only)
// @P lyrics array[Ms::Lyrics] the list of lyrics (read only)
// @P graceNotes array[Ms::Chord] the list of grace note chords (read only)
//---------------------------------------------------------
class Chord : public ChordRest {

4
libmscore/chordrest.h
View file

@ -41,8 +41,8 @@ class Spanner;
/// Virtual base class. Chords and rests can be part of a beam
//
// @P durationType int
// @P beamMode BeamMode
// @P small bool small chord/rest
// @P beamMode Ms::BeamMode (AUTO, BEGIN, MID, END, NONE, BEGIN32, BEGIN64, INVALID)
// @P small bool small chord/rest
//-------------------------------------------------------------------
class ChordRest : public DurationElement {

6
libmscore/clef.h
View file

@ -107,10 +107,10 @@ class ClefInfo {
//---------------------------------------------------------
// @@ Clef
/// Graphic representation of a clef.
/// Graphic representation of a clef.
//
// @P showCourtesy bool
// @P small bool r/o, set by layout
// @P showCourtesy bool
// @P small bool set by layout (read only)
//---------------------------------------------------------
class Clef : public Element {

18
libmscore/cursor.h
View file

@ -28,15 +28,15 @@ class Measure;
//---------------------------------------------------------
// @@ Cursor
// @P track int current track
// @P staffIdx int current staff (track / 4)
// @P voice int current voice (track % 4)
// @P element Element* current element at track, read only
// @P segment Segment* current segment, read only
// @P measure Measure* current measure, read only
// @P tick int midi tick position, read only
// @P time double time at tick position, read only
// @P score Score* associated score
// @P track int current track
// @P staffIdx int current staff (track / 4)
// @P voice int current voice (track % 4)
// @P element Ms::Element* current element at track, read only
// @P segment Ms::Segment* current segment, read only
// @P measure Ms::Measure* current measure, read only
// @P tick int midi tick position, read only
// @P time double time at tick position, read only
// @P score Ms::Score* associated score
//---------------------------------------------------------
class Cursor : public QObject {

4
libmscore/duration.h
View file

@ -24,9 +24,9 @@ class Spanner;
//---------------------------------------------------------
// @@ DurationElement
/// Virtual base class for Chord, Rest and Tuplet.
/// Virtual base class for Chord, Rest and Tuplet.
//
// @P duration int duration in ticks
// @P duration int duration in ticks
//---------------------------------------------------------
class DurationElement : public Element {

4
libmscore/dynamic.h
View file

@ -23,9 +23,9 @@ class Segment;
//-----------------------------------------------------------------------------
// @@ Dynamic
/// dynamics marker; determines midi velocity
/// dynamics marker; determines midi velocity
//
// @P range DynamicRange DYNAMIC_STAFF, DYNAMIC_PART, DYNAMIC_SYSTEM
// @P range Ms::Element::DynamicRange (DYNAMIC_STAFF, DYNAMIC_PART, DYNAMIC_SYSTEM)
//-----------------------------------------------------------------------------
class Dynamic : public Text {

34
libmscore/element.h
View file

@ -131,23 +131,23 @@ struct ElementName {
//-------------------------------------------------------------------
// @@ Element
/// \brief Base class of score layout elements
/// \brief Base class of score layout elements
///
/// The Element class is the virtual base class of all
/// score layout elements.
/// The Element class is the virtual base class of all
/// score layout elements.
//
// @P type ElementType element type, read only
// @P parent Element* parent in drawing hierarchy
// @P track int
// @P color QColor foreground color
// @P generated bool generated by layout
// @P visible bool
// @P selected bool
// @P placement Placement ABOVE, BELOW
// @P pos QPointF position relativ to parent
// @P pagePos QPointF position in page coordinated, read only
// @P userOff QPointF manual offset to layout position
// @P bbox QRectF Bounding box relative to pos and userOff, read only
// @P type Ms::ElementType element type, read only
// @P parent Ms::Element* parent in drawing hierarchy
// @P track int
// @P color QColor foreground color
// @P generated bool generated by layout
// @P visible bool
// @P selected bool
// @P placement Ms::Placement (ABOVE, BELOW)
// @P pos QPointF position relativ to parent
// @P pagePos QPointF position in page coordinated, read only
// @P userOff QPointF manual offset to layout position
// @P bbox QRectF Bounding box relative to pos and userOff, read only
//-------------------------------------------------------------------
class Element : public QObject {
@ -593,8 +593,8 @@ class ElementList : public QList<Element*> {
//-------------------------------------------------------------------
// @@ StaffLines
/// The StaffLines class is the graphic representation of a staff,
/// it draws the horizontal staff lines.
/// The StaffLines class is the graphic representation of a staff,
/// it draws the horizontal staff lines.
//-------------------------------------------------------------------
class StaffLines : public Element {

28
libmscore/figuredbass.h
View file

@ -64,17 +64,17 @@ and it is edited (via the normalized text); so it is derived from Text.
// @@ FiguredBassItem
/// One line of a figured bass indication
//
// @P prefix enum FiguredBassItem.ModifierNone, .ModifierDoubleFlat, .ModifierFlat, .ModifierNatural, .ModifierSharp, .ModifierDoubleSharp the accidental before the digit
// @P digit int the main digit (0 - 9)
// @P suffix enum FiguredBassItem.ModifierNone, .ModifierDoubleFlat, .ModifierFlat, .ModifierNatural, .ModifierSharp, .ModifierDoubleSharp, .ModifierPlus, .ModifierBackslash, .ModifierSlash the accidental/diacritic after the digit
// @P continuationLine bool whether the item has a continuation line or not
// @P parenthesis1 enum FiguredBassItem.ParenthesisNone, .ParenthesisRoundOpen, ParenthesisRoundClosed, ParenthesisSquaredOpen, ParenthesisSquaredClosed the parentesis before the prefix
// @P parenthesis2 enum FiguredBassItem.ParenthesisNone, .ParenthesisRoundOpen, ParenthesisRoundClosed, ParenthesisSquaredOpen, ParenthesisSquaredClosed the parentesis after the prefix / before the digit
// @P parenthesis3 enum FiguredBassItem.ParenthesisNone, .ParenthesisRoundOpen, ParenthesisRoundClosed, ParenthesisSquaredOpen, ParenthesisSquaredClosed the parentesis after the digit / before the suffix
// @P parenthesis4 enum FiguredBassItem.ParenthesisNone, .ParenthesisRoundOpen, ParenthesisRoundClosed, ParenthesisSquaredOpen, ParenthesisSquaredClosed the parentesis after the suffix / before the cont. line
// @P parenthesis5 enum FiguredBassItem.ParenthesisNone, .ParenthesisRoundOpen, ParenthesisRoundClosed, ParenthesisSquaredOpen, ParenthesisSquaredClosed the parentesis after the cont. line
// @P displayText string R/O the text displayed (depends on configured fonts)
// @P normalizedText string R/O conventional textual representation of item properties (= text used during input)
// @P prefix Ms::FiguredBassItem (ModifierNone, ModifierDoubleFlat, ModifierFlat, ModifierNatural, ModifierSharp, ModifierDoubleSharp) accidental before the digit
// @P digit int main digit (0 - 9)
// @P suffix Ms::FiguredBassItem (ModifierNone, ModifierDoubleFlat, ModifierFlat, ModifierNatural, ModifierSharp, ModifierDoubleSharp, ModifierPlus, ModifierBackslash, ModifierSlash) accidental/diacritic after the digit
// @P continuationLine bool whether item has continuation line or not
// @P parenthesis1 Ms::FiguredBassItem (ParenthesisNone, ParenthesisRoundOpen, ParenthesisRoundClosed, ParenthesisSquaredOpen, ParenthesisSquaredClosed) parentesis before the prefix
// @P parenthesis2 Ms::FiguredBassItem (ParenthesisNone, ParenthesisRoundOpen, ParenthesisRoundClosed, ParenthesisSquaredOpen, ParenthesisSquaredClosed) parentesis after the prefix / before the digit
// @P parenthesis3 Ms::FiguredBassItem (ParenthesisNone, ParenthesisRoundOpen, ParenthesisRoundClosed, ParenthesisSquaredOpen, ParenthesisSquaredClosed) parentesis after the digit / before the suffix
// @P parenthesis4 Ms::FiguredBassItem (ParenthesisNone, ParenthesisRoundOpen, ParenthesisRoundClosed, ParenthesisSquaredOpen, ParenthesisSquaredClosed) parentesis after the suffix / before the cont. line
// @P parenthesis5 Ms::FiguredBassItem (ParenthesisNone, ParenthesisRoundOpen, ParenthesisRoundClosed, ParenthesisSquaredOpen, ParenthesisSquaredClosed) parentesis after the cont. line
// @P displayText QString text displayed (depends on configured fonts) (read only)
// @P normalizedText Qstring conventional textual representation of item properties (= text used during input) (read ony)
//---------------------------------------------------------
class FiguredBass;
@ -240,10 +240,10 @@ struct FiguredBassFont {
//---------------------------------------------------------
// @@ FiguredBass
/// A complete figured bass indication
/// A complete figured bass indication
//
// @P onNote bool whether it is placed on a note beginning or between notes (r/o)
// @P ticks int duration in ticks
// @P onNote bool whether it is placed on a note beginning or between notes (read only)
// @P ticks int duration in ticks
//---------------------------------------------------------
class FiguredBass : public Text {

1
libmscore/fret.h
View file

@ -23,6 +23,7 @@ class Harmony;
//---------------------------------------------------------
// @@ FretDiagram
/// Fretboard diagram
//---------------------------------------------------------
class FretDiagram : public Element {

4
libmscore/glissando.h
View file

@ -29,8 +29,8 @@ enum class GlissandoType {
//---------------------------------------------------------
// @@ Glissando
// @P glissandoType GlissandoType (STRAIGHT, WAVY)
// @P text Qstring
// @P glissandoType Ms::GlissandoType (STRAIGHT, WAVY)
// @P text QString
// @P showText bool
//---------------------------------------------------------

4
libmscore/groups.h
View file

@ -40,8 +40,8 @@ struct GroupNode {
};
//---------------------------------------------------------
// Groups
// GroupNodes must be sorted by tick
// @@ Groups
/// GroupNodes must be sorted by tick
//---------------------------------------------------------
class Groups : public std::vector<GroupNode> {

6
libmscore/hairpin.h
View file

@ -57,9 +57,9 @@ class HairpinSegment : public LineSegment {
//---------------------------------------------------------
// @@ Hairpin
// @P hairpinType enum HairpinType CRESCENDO, DECRESCENDO
// @P veloChange int
// @P dynRange enum Element::DynamicRange
// @P hairpinType Ms::Hairpin::HairpinType (CRESCENDO, DECRESCENDO)
// @P veloChange int
// @P dynRange Ms::Element::DynamicRange (DYNAMIC_STAFF, DYNAMIC_PART, DYNAMIC_SYSTEM)
//---------------------------------------------------------
class Hairpin : public SLine {

8
libmscore/harmony.h
View file

@ -44,10 +44,6 @@ struct TextSegment {
//---------------------------------------------------------
// @@ Harmony
// @P id int harmony identifier
// @P rootTpc int root note as "tonal pitch class"
// @P baseTpc int bass note as "tonal pitch class"
//
/// root note and bass note are notated as
/// "tonal pitch class":
///
@ -59,6 +55,10 @@ struct TextSegment {
/// 1, 8, 15, 22, 29, // G
/// 3, 10, 17, 24, 31, // A
/// 5, 12, 19, 26, 33, // B
//
// @P id int harmony identifier
// @P rootTpc int root note as "tonal pitch class"
// @P baseTpc int bass note as "tonal pitch class"
//---------------------------------------------------------
struct RenderAction;

2
libmscore/jump.h
View file

@ -33,7 +33,7 @@ enum class JumpType {
//---------------------------------------------------------
// @@ Jump
/// Jump label
/// Jump label
//
// @P jumpTo QString
// @P playUntil QString

4
libmscore/keysig.h
View file

@ -37,9 +37,9 @@ struct KeySym {
//---------------------------------------------------------------------------------------
// @@ KeySig
/// The KeySig class represents a Key Signature on a staff
/// The KeySig class represents a Key Signature on a staff
//
// @P showCourtesy bool show courtesy key signature for this sig if appropriate
// @P showCourtesy bool show courtesy key signature for this sig if appropriate
//---------------------------------------------------------------------------------------
class KeySig : public Element {

2
libmscore/layoutbreak.h
View file

@ -25,7 +25,7 @@ namespace Ms {
// @@ LayoutBreak
/// symbols for line break, page break etc.
//
// @P layoutBreakType enum PAGE, LINE, SECTION
// @P layoutBreakType Ms::LayoutBreak::LayoutBreakType (PAGE, LINE, SECTION)
//---------------------------------------------------------
class LayoutBreak : public Element {

10
libmscore/ledgerline.h
View file

@ -21,11 +21,11 @@ class Chord;
//---------------------------------------------------------
// @@ LedgerLine
/// Graphic representation of a ledger line.
///
/// parent: Chord
/// x-origin: Chord
/// y-origin: SStaff
/// Graphic representation of a ledger line.
//!
//! parent: Chord
//! x-origin: Chord
//! y-origin: SStaff
//---------------------------------------------------------
class LedgerLine : public Line {

12
libmscore/line.h
View file

@ -40,12 +40,12 @@ enum class LineStyle {
//---------------------------------------------------------
// @@ LineSegment
/// Virtual base class for segmented lines segments
/// (OttavaSegment, HairpinSegment, TrillSegment...)
//
/// This class describes one segment of an segmented
/// line object. Line objects can span multiple staves.
/// For every staff a segment is created.
/// Virtual base class for segmented lines segments
/// (OttavaSegment, HairpinSegment, TrillSegment...)
///
/// This class describes one segment of an segmented
/// line object. Line objects can span multiple staves.
/// For every staff a segment is created.
//---------------------------------------------------------
class LineSegment : public SpannerSegment {

2
libmscore/lyrics.h
View file

@ -25,7 +25,7 @@ class Chord;
//---------------------------------------------------------
// @@ Lyrics
// @P syllabic enum SINGLE, BEGIN, END, MIDDLE
// @P syllabic Ms::Lyrics::Syllabic (SINGLE, BEGIN, END, MIDDLE)
//---------------------------------------------------------
class Lyrics : public Text {

4
libmscore/marker.h
View file

@ -35,8 +35,8 @@ enum class MarkerType {
//---------------------------------------------------------
// @@ Marker
//
// @P label QString
// @P markerType MarkerType
// @P label QString
// @P markerType Ms::MarkerType (SEGNO, VARSEGNO, CODA, VARCODA, CODETTA, FINE, TOCODA, USER)
//---------------------------------------------------------
class Marker : public Text {

6
libmscore/measurebase.h
View file

@ -29,10 +29,10 @@ class Measure;
//---------------------------------------------------------
// @@ MeasureBase
/// Virtual base class for Measure, HBox and VBox
/// Virtual base class for Measure, HBox and VBox
//
// @P lineBreak bool true if a system break is positioned on this measure
// @P pageBreak bool true if a page break is positioned on this measure
// @P lineBreak bool true if a system break is positioned on this measure
// @P pageBreak bool true if a page break is positioned on this measure
//---------------------------------------------------------
class MeasureBase : public Element {

46
libmscore/note.h
View file

@ -114,30 +114,30 @@ class NoteHead : public Symbol {
//---------------------------------------------------------------------------------------
// @@ Note
/// Graphic representation of a note.
/// Graphic representation of a note.
//
// @P subchannel int midi subchannel (for midi articulation) (read only)
// @P line int notehead position (read only)
// @P fret int fret number in tablature
// @P string int string number in tablature
// @P tpc int tonal pitch class, as per concert pitch setting
// @P tpc1 int tonal pitch class, non transposed
// @P tpc2 int tonal pitch class, transposed
// @P pitch int midi pitch
// @P ppitch int actual played midi pitch (honoring ottavas) (read only)
// @P ghost bool ghost note (guitar: death note)
// @P hidden bool hidden, not played note (read only)
// @P mirror bool mirror note head on x axis (read only)
// @P small bool small note head
// @P play bool play note
// @P tuning qreal tuning offset in cent
// @P veloType enum OFFSET_VAL, USER_VAL
// @P veloOffset int
// @P userMirror enum DH_AUTO, DH_LEFT, DH_RIGHT
// @P userDotPosition enum AUTO, UP, DOWN
// @P headGroup enum HEAD_NORMAL, HEAD_CROSS, HEAD_DIAMOND, HEAD_TRIANGLE, HEAD_MI, HEAD_SLASH, HEAD_XCIRCLE, HEAD_DO, HEAD_RE, HEAD_FA, HEAD_LA, HEAD_TI, HEAD_SOL, HEAD_BREVIS_ALT
// @P headType enum HEAD_AUTO, HEAD_WHOLE, HEAD_HALF, HEAD_QUARTER, HEAD_BREVIS
// @P elements array[Element] list of elements attached to note head
// @P subchannel int midi subchannel (for midi articulation) (read only)
// @P line int notehead position (read only)
// @P fret int fret number in tablature
// @P string int string number in tablature
// @P tpc int tonal pitch class, as per concert pitch setting
// @P tpc1 int tonal pitch class, non transposed
// @P tpc2 int tonal pitch class, transposed
// @P pitch int midi pitch
// @P ppitch int actual played midi pitch (honoring ottavas) (read only)
// @P ghost bool ghost note (guitar: death note)
// @P hidden bool hidden, not played note (read only)
// @P mirror bool mirror note head on x axis (read only)
// @P small bool small note head
// @P play bool play note
// @P tuning qreal tuning offset in cent
// @P veloType Ms::ValueType (OFFSET_VAL, USER_VAL)
// @P veloOffset int
// @P userMirror Ms::DirectionH (DH_AUTO, DH_LEFT, DH_RIGHT)
// @P userDotPosition Ms::Direction (AUTO, UP, DOWN)
// @P headGroup Ms::NoteHeadGroup (HEAD_NORMAL, HEAD_CROSS, HEAD_DIAMOND, HEAD_TRIANGLE, HEAD_MI, HEAD_SLASH, HEAD_XCIRCLE, HEAD_DO, HEAD_RE, HEAD_FA, HEAD_LA, HEAD_TI, HEAD_SOL, HEAD_BREVIS_ALT)
// @P headType Ms::NoteHeadType (HEAD_AUTO, HEAD_WHOLE, HEAD_HALF, HEAD_QUARTER, HEAD_BREVIS)
// @P elements array[Ms::Element] list of elements attached to note head
//---------------------------------------------------------------------------------------
class Note : public Element {

2
libmscore/ossia.h
View file

@ -19,7 +19,7 @@ namespace Ms {
//---------------------------------------------------------
// @@ Ossia
/// not implemented yet
/// not implemented yet
//---------------------------------------------------------
class Ossia : public Element {

2
libmscore/ottava.h
View file

@ -68,7 +68,7 @@ enum class OttavaType {
//---------------------------------------------------------
// @@ Ottava
// @P ottavaType enum OttavaType OTTAVA_8VA, OTTAVA_15MA, OTTAVA_8VB, OTTAVA_15MB, OTTAVA_22MA, OTTAVA_22MB
// @P ottavaType Ms::OttavaType (OTTAVA_8VA, OTTAVA_15MA, OTTAVA_8VB, OTTAVA_15MB, OTTAVA_22MA, OTTAVA_22MB)
//---------------------------------------------------------
class Ottava : public TextLine {

18
libmscore/page.h
View file

@ -42,15 +42,15 @@ extern const PaperSize* getPaperSize(const qreal wi, const qreal hi);
//---------------------------------------------------------
// @@ PageFormat
// @P size QSizeF paper size in inch
// @P printableWidth qreal
// @P evenLeftMargin qreal
// @P oddLeftMargin qreal
// @P eventTopMargin qreal
// @P oddTopMargin qreal
// @P evenBottomMargin qreal
// @P oddBottomMargin qreal
// @P twosided bool
// @P size QSizeF paper size in inch
// @P printableWidth qreal
// @P evenLeftMargin qreal
// @P oddLeftMargin qreal
// @P eventTopMargin qreal
// @P oddTopMargin qreal
// @P evenBottomMargin qreal
// @P oddBottomMargin qreal
// @P twosided bool
//---------------------------------------------------------
class PageFormat : public QObject {

8
libmscore/plugins.h
View file

@ -57,7 +57,7 @@ class FileIO : public QObject {
//---------------------------------------------------------
// MsProcess
// @@ QProcess
// @@ QProcess
//---------------------------------------------------------
class MsProcess : public QProcess {
@ -74,10 +74,10 @@ class MsProcess : public QProcess {
//---------------------------------------------------------
// @@ ScoreView
/// This is an GUI element to show a score.
/// This is an GUI element to show a score.
//
// @P color QColor background color
// @P scale qreal scaling factor
// @P color QColor background color
// @P scale qreal scaling factor
//---------------------------------------------------------
class MsScoreView : public QQuickPaintedItem, public MuseScoreView {

2
libmscore/rest.h
View file

@ -22,7 +22,7 @@ enum class SymId;
//---------------------------------------------------------
// @@ Rest
/// This class implements a rest.
/// This class implements a rest.
//---------------------------------------------------------
class Rest : public ChordRest {

8
libmscore/score.h
View file

@ -223,10 +223,10 @@ struct Layer {
//---------------------------------------------------------
// @@ Score
// @P name QString name of the score
// @P nstaves int number of staves, read only
// @P ntracks int number of tracks (staves * 4), read only
// @P npages int number of pages, read only
// @P name QString name of the score
// @P nstaves int number of staves (read only)
// @P ntracks int number of tracks (staves * 4) (read only)
// @P npages int number of pages (read only)
//---------------------------------------------------------
class Score : public QObject {

6
libmscore/segment.h
View file

@ -33,10 +33,10 @@ class System;
//------------------------------------------------------------------------
// @@ Segment
/// A segment holds all vertical aligned staff elements.
/// Segments are typed and contain only Elements of the same type.
/// A segment holds all vertical aligned staff elements.
/// Segments are typed and contain only Elements of the same type.
//
// @P segmentType SegmentType
// @P segmentType Ms::Segment::SegmentType (SegInvalid, SegClef, SegKeySig, SegAmbitus, SegTimeSig, SegStartRepeatBarLine, SegBarLine, SegChordRest, SegBreath, SegEndBarLine SegTimeSigAnnounce, SegKeySigAnnounce, SegAll)
//------------------------------------------------------------------------
/**

4
libmscore/slur.h
View file

@ -119,8 +119,8 @@ class SlurSegment : public SpannerSegment {
//-------------------------------------------------------------------
// @@ SlurTie
// @P lineType int 0 - solid, 1 - dotted, 2 - dashed
// @P slurDirection Direction AUTO, UP, DOWN
// @P lineType int (0 - solid, 1 - dotted, 2 - dashed)
// @P slurDirection Direction (AUTO, UP, DOWN)
//-------------------------------------------------------------------
class SlurTie : public Spanner {

2
libmscore/spanner.h
View file

@ -33,7 +33,7 @@ enum SpannerSegmentType {
//---------------------------------------------------------
// @@ SpannerSegment
// parent: System
//! parent: System
//---------------------------------------------------------
class SpannerSegment : public Element {

2
libmscore/staff.h
View file

@ -79,7 +79,7 @@ struct BracketItem {
//---------------------------------------------------------
// @@ Staff
/// Global staff data not directly related to drawing.
/// Global staff data not directly related to drawing.
//---------------------------------------------------------
class Staff : public QObject {

2
libmscore/stem.h
View file

@ -23,7 +23,7 @@ class Chord;
//---------------------------------------------------------
// @@ Stem
/// Graphic representation of a note stem.
/// Graphic representation of a note stem.
//---------------------------------------------------------
class Stem : public Element {

2
libmscore/stemslash.h
View file

@ -20,7 +20,7 @@ namespace Ms {
//---------------------------------------------------------
// @@ StemSlash
/// used for grace notes of type acciaccatura
/// used for grace notes of type acciaccatura
//---------------------------------------------------------
class StemSlash : public Element {

4
libmscore/symbol.h
View file

@ -25,7 +25,7 @@ enum class SymId;
//---------------------------------------------------------
// @@ Symbol
/// Symbol constructed from builtin symbol.
/// Symbol constructed from builtin symbol.
//---------------------------------------------------------
class Symbol : public BSymbol {
@ -59,7 +59,7 @@ class Symbol : public BSymbol {
//---------------------------------------------------------
// @@ FSymbol
/// Symbol constructed from a font glyph.
/// Symbol constructed from a font glyph.
//---------------------------------------------------------
class FSymbol : public BSymbol {

4
libmscore/system.h
View file

@ -73,8 +73,8 @@ class SysStaff {
//---------------------------------------------------------
// @@ System
/// One row of measures for all instruments;
/// a complete piece of the timeline.
/// One row of measures for all instruments;
/// a complete piece of the timeline.
//---------------------------------------------------------
class System : public Element {

6
libmscore/tempotext.h
View file

@ -20,10 +20,10 @@ namespace Ms {
//-------------------------------------------------------------------
// @@ TempoText
/// Tempo marker which determines the midi tempo.
/// Tempo marker which determines the midi tempo.
//
// @P tempo qreal tempo in beats per second (beat=1/4)
// @P followText bool determine tempo from text
// @P tempo qreal tempo in beats per second (beat=1/4)
// @P followText bool determine tempo from text
//-------------------------------------------------------------------
class TempoText : public Text {

4
libmscore/text.h
View file

@ -168,9 +168,9 @@ class TextBlock {
//---------------------------------------------------------
// @@ Text
/// Graphic representation of a text.
/// Graphic representation of a text.
//
// @P text string the raw text
// @P text Qstring the raw text
//---------------------------------------------------------
class Text : public Element {

2
libmscore/textframe.h
View file

@ -19,7 +19,7 @@ namespace Ms {
//---------------------------------------------------------
// @@ TBox
/// Text frame.
/// Text frame.
//---------------------------------------------------------
class TBox : public VBox {

2
libmscore/tie.h
View file

@ -27,7 +27,7 @@ struct SlurPos;
//---------------------------------------------------------
// @@ Tie
/// ties have a Note as startElement/endElement
//! a Tie has a Note as startElement/endElement
//---------------------------------------------------------
class Tie : public SlurTie {

16
libmscore/timesig.h
View file

@ -35,14 +35,14 @@ enum TimeSigType {
// @@ TimeSig
/// This class represents a time signature.
//
// @P numeratorString QString text of numerator
// @P denominatorString QString text of denominator
// @P showCourtesySig bool show courtesy time signature for this sig if appropriate
// @P numerator int (read only)
// @P denominator int (read only)
// @P numeratorStretch int (read only)
// @P denominatorStretch int (read only)
// @P groups Groups
// @P numeratorString QString text of numerator
// @P denominatorString QString text of denominator
// @P showCourtesySig bool show courtesy time signature for this sig if appropriate
// @P numerator int (read only)
// @P denominator int (read only)
// @P numeratorStretch int (read only)
// @P denominatorStretch int (read only)
// @P groups Groups
//---------------------------------------------------------------------------------------
class TimeSig : public Element {

2
libmscore/trill.h
View file

@ -57,7 +57,7 @@ class TrillSegment : public LineSegment {
//---------------------------------------------------------
// @@ Trill
// @P trillType enum TrillType TRILL_LINE, UPPRALL_LINE, DOWNPRALL_LINE, PRALLPRALL_LINE, PURE_LINE
// @P trillType Ms::Trill::TrillType (TRILL_LINE, UPPRALL_LINE, DOWNPRALL_LINE, PRALLPRALL_LINE, PURE_LINE)
//---------------------------------------------------------
class Trill : public SLine {

14
libmscore/tuplet.h
View file

@ -24,13 +24,13 @@ class Spanner;
//------------------------------------------------------------------------
// @@ Tuplet
/// Example of 1/8 triplet:
/// _baseLen = 1/8
/// _actualNotes = 3
/// _normalNotes = 2 (3 notes played in the time of 2/8)
//
/// The tuplet has a len of _baseLen * _normalNotes.
/// A tuplet note has len of _baseLen * _normalNotes / _actualNotes.
//! Example of 1/8 triplet:
//! _baseLen = 1/8
//! _actualNotes = 3
//! _normalNotes = 2 (3 notes played in the time of 2/8)
//!
//! The tuplet has a len of _baseLen * _normalNotes.
//! A tuplet note has len of _baseLen * _normalNotes / _actualNotes.
//------------------------------------------------------------------------
class Tuplet : public DurationElement {

2
libmscore/volta.h
View file

@ -57,7 +57,7 @@ class VoltaSegment : public TextLineSegment {
//---------------------------------------------------------
// @@ Volta
// @P voltaType enum VoltaType OPEN, CLOSED
// @P voltaType Ms::VoltaType (OPEN, CLOSED)
//---------------------------------------------------------
class Volta : public TextLine {

26
mscore/qmlplugin.h
View file

@ -34,19 +34,19 @@ extern int updateVersion();
//---------------------------------------------------------
// QmlPlugin
// @@ MuseScore
// @P menuPath QString where the plugin is placed in menu
// @P version QString
// @P description QString
// @P pluginType QString
// @P dockArea QString
// @P division int number of MIDI ticks for 1/4 note, read only
// @P mscoreVersion int the complete version number of MuseScore in the form: MMmmuu, read only
// @P mscoreMajorVersion int the 1st part of the MuseScore version, read only
// @P mscoreMinorVersion int the 2nd part of the MuseScore version, read only
// @P mscoreUpdateVersion int the 3rd part of the MuseScore version, read only
// @P mscoreDPI qreal read only
// @P curScore Score* the current score, if any, read only
// @P scores array[Score] all currently open scores, read only
// @P menuPath QString where the plugin is placed in menu
// @P version QString
// @P description QString
// @P pluginType QString
// @P dockArea QString
// @P division int number of MIDI ticks for 1/4 note (read only)
// @P mscoreVersion int complete version number of MuseScore in the form: MMmmuu (read only)
// @P mscoreMajorVersion int 1st part of the MuseScore version (read only)
// @P mscoreMinorVersion int 2nd part of the MuseScore version (read only)
// @P mscoreUpdateVersion int 3rd part of the MuseScore version (read only)
// @P mscoreDPI qreal (read only)
// @P curScore Ms::Score* current score, if any (read only)
// @P scores array[Ms::Score] all currently open scores (read only)
//---------------------------------------------------------
class QmlPlugin : public QQuickItem {