• R/O
  • SSH
  • HTTPS

cadencii: コミット


コミットメタ情報

リビジョン1902 (tree)
日時2011-12-14 02:08:58
作者kbinani

ログメッセージ

[luavsq] privateなフィールドのdocコメントを追加

変更サマリ

差分

--- luavsq/trunk/PhoneticSymbol.lua (revision 1901)
+++ luavsq/trunk/PhoneticSymbol.lua (revision 1902)
@@ -24,18 +24,26 @@
2424
2525 ---
2626 -- 日本語の母音発音記号
27+-- @var string
28+-- @access private static
2729 PhoneticSymbol._SYMBOL_VOWEL_JP = "\ta\ti\tM\te\to\t";
2830
2931 ---
3032 -- 日本語の子音発音記号
33+-- @var string
34+-- @access private static
3135 PhoneticSymbol._SYMBOL_CONSONANT_JP = "\tk\tk'\tg\tg'\tN\tN'\ts\tS\tz\tZ\tdz\tdZ\tt\tt'\tts\ttS\td\td'\tn\tJ\th\th\\\tC\tp\\\tp\\'\tb\tb'\tp\tp'\tm\tm'\tj\t4\t4'\tw\tN\\\t";
3236
3337 ---
3438 -- 英語の母音発音記号
39+-- @var string
40+-- @access private static
3541 PhoneticSymbol._SYMBOL_VOWEL_EN = "\t@\tV\te\te\tI\ti:\t{\tO:\tQ\tU\tu:\t@r\teI\taI\tOI\t@U\taU\tI@\te@\tU@\tO@\tQ@\t";
3642
3743 ---
3844 -- 英語の子音発音記号
45+-- @var string
46+-- @access private static
3947 PhoneticSymbol._SYMBOL_CONSONANT_EN = "\tw\tj\tb\td\tg\tbh\tdh\tgh\tdZ\tv\tD\tz\tZ\tm\tn\tN\tr\tl\tl0\tp\tt\tk\tph\tth\tkh\ttS\tf\tT\ts\tS\th\tSil\tAsp\t";
4048
4149 ---
--- luavsq/trunk/ByteArrayOutputStream.lua (revision 1901)
+++ luavsq/trunk/ByteArrayOutputStream.lua (revision 1902)
@@ -29,7 +29,17 @@
2929 -- @access static ctor
3030 function ByteArrayOutputStream.new()
3131 local this = {};
32+
33+ ---
34+ -- 現在のファイルポインタ
35+ -- @var int
36+ -- @access private
3237 this._pointer = -1;
38+
39+ ---
40+ -- 書き込み先のバイト列
41+ -- @var table
42+ -- @access private
3343 this._array = {};
3444
3545 --
--- luavsq/trunk/List.Iterator.lua (revision 1901)
+++ luavsq/trunk/List.Iterator.lua (revision 1902)
@@ -31,7 +31,17 @@
3131 -- @access static ctor
3232 function List.Iterator.new( list )
3333 local this = {};
34+
35+ ---
36+ -- 反復子の元になるリスト
37+ -- @var List
38+ -- @access private
3439 this._list = list;
40+
41+ ---
42+ -- 反復子の現在の位置
43+ -- @var int
44+ -- @access private
3545 this._pos = -1;
3646
3747 ---
--- luavsq/trunk/EventList.Iterator.lua (revision 1901)
+++ luavsq/trunk/EventList.Iterator.lua (revision 1902)
@@ -33,7 +33,17 @@
3333 -- @access static ctor
3434 function EventList.Iterator.new( list )
3535 local this = {};
36+
37+ ---
38+ -- 反復子の元になるリスト
39+ -- @var EventList
40+ -- @access private
3641 this._list = list;
42+
43+ ---
44+ -- 反復子の現在の位置
45+ -- @var int
46+ -- @access private
3747 this._pos = -1;
3848
3949 ---
--- luavsq/trunk/Sequence.lua (revision 1901)
+++ luavsq/trunk/Sequence.lua (revision 1902)
@@ -26,15 +26,41 @@
2626 -- @name Sequence
2727 Sequence = {};
2828
29+---
30+-- テンポが省略された際の、基準となるテンポ値
31+-- @var int
32+-- @access private static
2933 Sequence.baseTempo = 500000;
34+
35+---
36+-- MTRK ヘッダ
37+-- @var table<int>
38+-- @access private static
3039 Sequence._MTRK = { 0x4d, 0x54, 0x72, 0x6b };
40+
41+---
42+-- MTHD ヘッダ
43+-- @var table<int>
44+-- @access private static
3145 Sequence._MTHD = { 0x4d, 0x54, 0x68, 0x64 };
46+
47+---
48+-- Master Track のトラック名
49+-- @var table<int>
50+-- @access private static
3251 Sequence._MASTER_TRACK = { 0x4D, 0x61, 0x73, 0x74, 0x65, 0x72, 0x20, 0x54, 0x72, 0x61, 0x63, 0x6B };
52+
53+---
54+-- カーブ名のリスト
55+-- @var table<string>
56+-- @access private static
3357 Sequence._CURVES = { "VEL", "DYN", "BRE", "BRI", "CLE", "OPE", "GEN", "POR", "PIT", "PBS" };
3458
35---
59+---
3660 -- VOCALOID の NRPN を出力するかどうか
3761 -- @todo NRPN 出力関連の メソッドのテストが書けたらデフォルトで true にする
62+-- @var boolean
63+-- @access private static
3864 Sequence._WRITE_NRPN = false;
3965
4066 --
@@ -44,6 +70,10 @@
4470 local this = {};
4571 local arguments = { ... };
4672
73+ ---
74+ -- 四分音符 1 個あたりの Tick 数
75+ -- @var int
76+ -- @access private static
4777 this._tickPerQuarter = 480;
4878
4979 ---
@@ -61,8 +91,10 @@
6191 -- @var TimesigList
6292 this.timesigList = nil;
6393
64- --
65- -- 曲の長さを取得します。(クロック(4分音符は480クロック))
94+ ---
95+ -- Tick 単位の曲の長さ
96+ -- @var int
97+ -- @access private
6698 this._totalClocks = 0;
6799
68100 ---
--- luavsq/trunk/BPList.KeyClockIterator.lua (revision 1901)
+++ luavsq/trunk/BPList.KeyClockIterator.lua (revision 1902)
@@ -32,13 +32,20 @@
3232 -- @access static ctor
3333 -- @class function
3434
35---
36--- 初期化を行う
37--- @return (BPList.KeyClockIterator)
3835 function BPList.KeyClockIterator.new( ... )
3936 local this = {};
4037 local arguments = { ... };
38+
39+ ---
40+ -- 反復子の元になるリスト
41+ -- @var table
42+ -- @access private
4143 this._list = nil;
44+
45+ ---
46+ -- 反復子の現在の位置
47+ -- @var int
48+ -- @access private
4249 this._pos = 0;
4350
4451 ---
--- luavsq/trunk/List.lua (revision 1901)
+++ luavsq/trunk/List.lua (revision 1902)
@@ -37,6 +37,11 @@
3737 function List.new( ... )
3838 local this = {};
3939 local arguments = { ... };
40+
41+ ---
42+ -- リストの元になる <code>table</code>
43+ -- @var table
44+ -- @access private
4045 this._array = {};
4146
4247 ---
--- luavsq/trunk/FileOutputStream.lua (revision 1901)
+++ luavsq/trunk/FileOutputStream.lua (revision 1902)
@@ -30,6 +30,11 @@
3030 -- @access static ctor
3131 function FileOutputStream.new( path )
3232 local this = {};
33+
34+ ---
35+ -- ファイルハンドル
36+ -- @var userdata
37+ -- @access private
3338 this._fileHandle = io.open( path, "wb" );
3439
3540 --
--- luavsq/trunk/EventList.lua (revision 1901)
+++ luavsq/trunk/EventList.lua (revision 1902)
@@ -34,11 +34,13 @@
3434 local this = {};
3535
3636 ---
37+ -- イベントのリスト
3738 -- @var table<Event>
3839 -- @access private
3940 this._events = {};
4041
4142 ---
43+ -- イベントの ID のリスト
4244 -- @var table<int>
4345 -- @access private
4446 this._ids = {};
--- luavsq/trunk/Event.lua (revision 1901)
+++ luavsq/trunk/Event.lua (revision 1902)
@@ -62,6 +62,10 @@
6262 -- @var Handle
6363 this.singerHandle = nil;
6464
65+ ---
66+ -- Tick 単位のイベント長さ
67+ -- @var int
68+ -- @access private
6569 this._length = 0;
6670
6771 ---
--- luavsq/trunk/Log.lua (revision 1901)
+++ luavsq/trunk/Log.lua (revision 1902)
@@ -21,7 +21,16 @@
2121 -- @access private
2222 Log = {};
2323
24+---
25+-- ログレベル
26+-- @var int
27+-- @access private static
2428 Log._level = 0;
29+
30+---
31+-- ログファイルのファイルハンドル
32+-- @var userdata
33+-- @access private static
2534 Log._fileHandle = nil;
2635
2736 ---
@@ -47,7 +56,7 @@
4756 ---
4857 -- 文字列をログに出力する。文字列の末尾に改行が追加される
4958 -- @param message (string) ログ出力する文字列
50--- @access static
59+-- @access private static
5160 function Log.println( message )
5261 if( Log._level > 0 )then
5362 local fp = Log._getFileHandle();
@@ -56,6 +65,10 @@
5665 end
5766 end
5867
68+---
69+-- ログファイルのファイルハンドルを取得する
70+-- @return (userdata) ログファイルのファイルハンドル
71+-- @access private static
5972 function Log._getFileHandle()
6073 if( Log._fileHandle == nil )then
6174 Log._fileHandle = io.open( "..\\luavsq.log", "a" );
--- luavsq/trunk/Lyric.lua (revision 1901)
+++ luavsq/trunk/Lyric.lua (revision 1902)
@@ -44,7 +44,16 @@
4444 -- @var boolean
4545 this.isProtected = false;
4646
47+ ---
48+ -- 発音記号のリスト
49+ -- @var table
50+ -- @access private
4751 this._phoneticSymbol = { "a" };
52+
53+ ---
54+ -- Consonant Adjustment のリスト
55+ -- @var table
56+ -- @access private
4857 this._consonantAdjustment = { 0 };
4958
5059 ---
--- luavsq/trunk/VibratoBPList.lua (revision 1901)
+++ luavsq/trunk/VibratoBPList.lua (revision 1902)
@@ -30,6 +30,11 @@
3030 function VibratoBPList.new( ... )
3131 local arguments = { ... };
3232 local this = {};
33+
34+ ---
35+ -- カーブのデータ点を保持するリスト
36+ -- @var table<VibratoBP>
37+ -- @access private
3338 this._list = {};
3439
3540 ---
--- luavsq/trunk/Common.lua (revision 1901)
+++ luavsq/trunk/Common.lua (revision 1902)
@@ -54,7 +54,10 @@
5454 -- @var PlayModeEnum
5555 this.playMode = PlayModeEnum.PLAY_WITH_SYNTH;
5656
57+ ---
5758 -- PlayModeがOff(-1)にされる直前に,PlayAfterSynthかPlayWithSynthのどちらが指定されていたかを記憶しておく.
59+ -- @var PlayModeEnum
60+ -- @access private
5861 this._lastPlayMode = PlayModeEnum.PLAY_WITH_SYNTH;
5962
6063 ---
--- luavsq/trunk/Handle.lua (revision 1901)
+++ luavsq/trunk/Handle.lua (revision 1902)
@@ -60,6 +60,10 @@
6060 -- @var string
6161 this.ids = "";
6262
63+ ---
64+ -- 歌詞一覧
65+ -- @var table
66+ -- @access private
6367 this._lyrics = {};
6468
6569 ---
@@ -67,11 +71,40 @@
6771 -- @var int
6872 this.original = 0;
6973
74+ ---
75+ -- キャプション
76+ -- @var string
77+ -- @access private
7078 this._caption = "";
79+
80+ ---
81+ -- 長さ
82+ -- @var int
83+ -- @access private
7184 this._length = 0;
85+
86+ ---
87+ -- Depth の開始値
88+ -- @var int
89+ -- @access private
7290 this._startDepth = 0;
91+
92+ ---
93+ -- Depth のカーブ
94+ -- @var VibratoBPList
95+ -- @access private
7396 this._depthBP = nil;
97+
98+ ---
99+ -- Rate の開始値
100+ -- @var int
101+ -- @access private
74102 this._startRate = 0;
103+
104+ ---
105+ -- Rate のカーブ
106+ -- @var VibratoBPList
107+ -- @access private
75108 this._rateBP = nil;
76109
77110 ---
@@ -84,10 +117,34 @@
84117 -- @var int
85118 this.program = 0;
86119
120+ ---
121+ -- Duration
122+ -- @var int
123+ -- @access private
87124 this._duration = 0;
125+
126+ ---
127+ -- Depth
128+ -- @var int
129+ -- @access private
88130 this._depth = 0;
131+
132+ ---
133+ -- Dyn の開始値
134+ -- @var int
135+ -- @access private
89136 this._startDyn = 0;
137+
138+ ---
139+ -- Dyn の終了値
140+ -- @var int
141+ -- @access private
90142 this._endDyn = 0;
143+
144+ ---
145+ -- Dyn のカーブ
146+ -- @var VibratoBPList
147+ -- @access private
91148 this._dynBP = nil;
92149
93150 ---
--- luavsq/trunk/tool/doclet/java.lua (revision 1901)
+++ luavsq/trunk/tool/doclet/java.lua (revision 1902)
@@ -452,8 +452,8 @@
452452 -- @return (table) ソート後のテーブル
453453 function sortItems( items )
454454 local comparator = function( a, b )
455- local nameA = a.name;
456- local nameB = b.name;
455+ local nameA = getShortName( a.name );
456+ local nameB = getShortName( b.name );
457457 return nameA < nameB;
458458 end
459459
--- luavsq/trunk/EventList.IndexIterator.lua (revision 1901)
+++ luavsq/trunk/EventList.IndexIterator.lua (revision 1902)
@@ -32,30 +32,63 @@
3232 -- @access static ctor
3333 function EventList.IndexIterator.new( list, iteratorKind )
3434 local this = {};
35+
3536 ---
36- -- @local [VsqEventList]
37+ -- 反復子の元になるリスト
38+ -- @var EventList
39+ -- @access private
3740 this._list = list;
41+
42+ ---
43+ -- 反復子の現在の位置
44+ -- @var int
45+ -- @access private
3846 this._pos = 0;
47+
48+ ---
49+ -- 歌手イベントを対象に含めるかどうか
50+ -- @var boolean
51+ -- @access private
3952 this._kindSinger =
4053 Util.band(
4154 iteratorKind,
4255 EventList.IndexIteratorKindEnum.SINGER
4356 ) == EventList.IndexIteratorKindEnum.SINGER;
57+
58+ ---
59+ -- 音符イベントを対象に含めるかどうか
60+ -- @var boolean
61+ -- @access private
4462 this._kindNote =
4563 Util.band(
4664 iteratorKind,
4765 EventList.IndexIteratorKindEnum.NOTE
4866 ) == EventList.IndexIteratorKindEnum.NOTE;
67+
68+ ---
69+ -- クレッシェンドイベントを対象に含めるかどうか
70+ -- @var boolean
71+ -- @access private
4972 this._kindCrescend =
5073 Util.band(
5174 iteratorKind,
5275 EventList.IndexIteratorKindEnum.CRESCENDO
5376 ) == EventList.IndexIteratorKindEnum.CRESCENDO;
77+
78+ ---
79+ -- デクレッシェンドイベントを対象に含めるかどうか
80+ -- @var boolean
81+ -- @access private
5482 this._kindDecrescend =
5583 Util.band(
5684 iteratorKind,
5785 EventList.IndexIteratorKindEnum.DECRESCENDO
5886 ) == EventList.IndexIteratorKindEnum.DECRESCENDO;
87+
88+ ---
89+ -- 強弱記号イベントを対象に含めるかどうか
90+ -- @var boolean
91+ -- @access private
5992 this._kindDynaff =
6093 Util.band(
6194 iteratorKind,
--- luavsq/trunk/BPList.lua (revision 1901)
+++ luavsq/trunk/BPList.lua (revision 1902)
@@ -36,20 +36,56 @@
3636 -- @access static ctor
3737 -- @class function
3838
39---
40--- コンストラクタ
41--- @return (BPList)
42--- @access static private
4339 function BPList.new( ... )
4440 local this = {};
4541 local arguments = { ... };
42+
43+ ---
44+ -- Tick 単位の時刻を格納したリスト
45+ -- @var table
46+ -- @access private
4647 this._clocks = nil;
48+
49+ ---
50+ -- データ点の値と id のセットを格納した {@link BP} のリスト
51+ -- @var table
52+ -- @access private
4753 this._items = nil;
48- this._length = 0; -- clocks, itemsに入っているアイテムの個数
54+
55+ ---
56+ -- 現在のリストの長さ
57+ -- @var int
58+ -- @access private
59+ this._length = 0;
60+
61+ ---
62+ -- コントロールカーブのデフォルト値
63+ -- @var int
64+ -- @access private
4965 this._defaultValue = 0;
66+
67+ ---
68+ -- コントロールカーブの最大値
69+ -- @var int
70+ -- @access private
5071 this._maxValue = 127;
72+
73+ ---
74+ -- コントロールカーブの最小値
75+ -- @var int
76+ -- @access private
5177 this._minValue = 0;
78+
79+ ---
80+ -- このリスト内で使用されている ID の最大値
81+ -- @var int
82+ -- @access private
5283 this._maxId = 0;
84+
85+ ---
86+ -- コントロールカーブの名前
87+ -- @var string
88+ -- @access private
5389 this._name = "";
5490
5591 ---
--- luavsq/trunk/TextStream.lua (revision 1901)
+++ luavsq/trunk/TextStream.lua (revision 1902)
@@ -29,8 +29,23 @@
2929 -- @access static ctor
3030 function TextStream.new()
3131 local this = {};
32+
33+ ---
34+ -- 書き込まれたデータを保持するバッファー
35+ -- @var table
36+ -- @access private
3237 this._array = {};
38+
39+ ---
40+ -- データの現在の長さ
41+ -- @var int
42+ -- @access private
3343 this._length = 0;
44+
45+ ---
46+ -- 現在の読み書き位置
47+ -- @var int
48+ -- @access private
3449 this._position = -1;
3550
3651 ---
--- luavsq/trunk/Track.lua (revision 1901)
+++ luavsq/trunk/Track.lua (revision 1902)
@@ -56,63 +56,134 @@
5656
5757 ---
5858 -- PIT。ピッチベンド(pitchBendBPList)。default=0
59+ -- @var BPList
60+ -- @access private
5961 this._pit = nil;
6062
6163 ---
6264 -- PBS。ピッチベンドセンシティビティ(pitchBendSensBPList)。dfault=2
65+ -- @var BPList
66+ -- @access private
6367 this._pbs = nil;
6468
6569 ---
6670 -- DYN。ダイナミクス(dynamicsBPList)。default=64
71+ -- @var BPList
72+ -- @access private
6773 this._dyn = nil;
6874
6975 ---
7076 -- BRE。ブレシネス(epRResidualBPList)。default=0
77+ -- @var BPList
78+ -- @access private
7179 this._bre = nil;
7280
7381 ---
7482 -- BRI。ブライトネス(epRESlopeBPList)。default=64
83+ -- @var BPList
84+ -- @access private
7585 this._bri = nil;
7686
7787 ---
7888 -- CLE。クリアネス(epRESlopeDepthBPList)。default=0
89+ -- @var BPList
90+ -- @access private
7991 this._cle = nil;
8092
93+ ---
94+ -- @var BPList
95+ -- @access private
8196 this._reso1FreqBPList = nil;
97+
98+ ---
99+ -- @var BPList
100+ -- @access private
82101 this._reso2FreqBPList = nil;
102+
103+ ---
104+ -- @var BPList
105+ -- @access private
83106 this._reso3FreqBPList = nil;
107+
108+ ---
109+ -- @var BPList
110+ -- @access private
84111 this._reso4FreqBPList = nil;
112+
113+ ---
114+ -- @var BPList
115+ -- @access private
85116 this._reso1BWBPList = nil;
117+
118+ ---
119+ -- @var BPList
120+ -- @access private
86121 this._reso2BWBPList = nil;
122+
123+ ---
124+ -- @var BPList
125+ -- @access private
87126 this._reso3BWBPList = nil;
127+
128+ ---
129+ -- @var BPList
130+ -- @access private
88131 this._reso4BWBPList = nil;
132+
133+ ---
134+ -- @var BPList
135+ -- @access private
89136 this._reso1AmpBPList = nil;
137+
138+ ---
139+ -- @var BPList
140+ -- @access private
90141 this._reso2AmpBPList = nil;
142+
143+ ---
144+ -- @var BPList
145+ -- @access private
91146 this._reso3AmpBPList = nil;
147+
148+ ---
149+ -- @var BPList
150+ -- @access private
92151 this._reso4AmpBPList = nil;
93152
94153 ---
95154 -- Harmonics。(EpRSineBPList)default = 64
155+ -- @var BPList
156+ -- @access private
96157 this._harmonics = nil;
97158
98159 ---
99160 -- Effect2 Depth。
161+ -- @var BPList
162+ -- @access private
100163 this._fx2depth = nil;
101164
102165 ---
103166 -- GEN。ジェンダーファクター(genderFactorBPList)。default=64
167+ -- @var BPList
168+ -- @access private
104169 this._gen = nil;
105170
106171 ---
107172 -- POR。ポルタメントタイミング(portamentoTimingBPList)。default=64
173+ -- @var BPList
174+ -- @access private
108175 this._por = nil;
109176
110177 ---
111178 -- OPE。オープニング(openingBPList)。default=127
179+ -- @var BPList
180+ -- @access private
112181 this._ope = nil;
113182
114183 ---
115184 -- cent単位のピッチベンド。vsqに保存するときは、VsqFile#reflectPitchによってPIT, PBSに落とし込む。それらの範囲をオーバーしてたら知らん(cutoff)
185+ -- @var BPList
186+ -- @access private
116187 this._pitch = nil;
117188
118189 ---
--- luavsq/trunk/NrpnEvent.lua (revision 1901)
+++ luavsq/trunk/NrpnEvent.lua (revision 1902)
@@ -60,6 +60,11 @@
6060 -- MSB の出力を省略するかどうか
6161 -- @var boolean
6262 this.isMSBOmittingRequired = false;
63+
64+ ---
65+ -- 子イベントのリスト
66+ -- @var table
67+ -- @access private
6368 this._list = nil;
6469
6570 ---
--- luavsq/trunk/TempoList.lua (revision 1901)
+++ luavsq/trunk/TempoList.lua (revision 1902)
@@ -26,6 +26,11 @@
2626 -- @access static ctor
2727 function TempoList.new()
2828 local this = {};
29+
30+ ---
31+ -- テンポ変更情報のリスト
32+ -- @var List<Tempo>
33+ -- @access private
2934 this._array = List.new();
3035
3136 ---
--- luavsq/trunk/Tempo.lua (revision 1901)
+++ luavsq/trunk/Tempo.lua (revision 1902)
@@ -37,6 +37,10 @@
3737 -- @var int
3838 this.tempo = 0;
3939
40+ ---
41+ -- テンポ変更の秒単位の時刻
42+ -- @var double
43+ -- @access private
4044 this._time = 0.0;
4145
4246 ---
--- luavsq/trunk/TimesigList.lua (revision 1901)
+++ luavsq/trunk/TimesigList.lua (revision 1902)
@@ -28,6 +28,11 @@
2828 -- @access static ctor
2929 function TimesigList.new()
3030 local this = {};
31+
32+ ---
33+ -- 拍子変更情報のリスト
34+ -- @var List<Timesig>
35+ -- @access private
3136 this._list = List.new();
3237
3338 ---
旧リポジトリブラウザで表示