edit doxygen comment
trunk/Doxyfile (diff)
trunk/libs/sound/CdromPlay.h (diff)
trunk/libs/sound/CdromPlay.cpp (diff) trunk/dox/mainpage.dox (diff) trunk/programs/Makefile (diff)| @@ -34,8 +34,8 @@ | ||
| 34 | 34 | \brief トラックのデータタイプ |
| 35 | 35 | */ |
| 36 | 36 | typedef enum { |
| 37 | - AudioTrack, | |
| 38 | - DataTrack, | |
| 37 | + AudioTrack, //!< 音楽トラック | |
| 38 | + DataTrack, //!< データトラック | |
| 39 | 39 | } TrackType; |
| 40 | 40 | |
| 41 | 41 | /*! |
| @@ -50,7 +50,11 @@ | ||
| 50 | 50 | } track_t; |
| 51 | 51 | |
| 52 | 52 | CdromPlay(void); |
| 53 | - explicit CdromPlay(size_t use_drive); | |
| 53 | + | |
| 54 | + /*! | |
| 55 | + \brief 使用ドライブ指定のコンストラクタ | |
| 56 | + */ | |
| 57 | + explicit CdromPlay(size_t drive_id); | |
| 54 | 58 | ~CdromPlay(void); |
| 55 | 59 | |
| 56 | 60 | /*! |
| @@ -77,6 +81,16 @@ | ||
| 77 | 81 | */ |
| 78 | 82 | bool getTracks(std::vector<track_t>& tracks); |
| 79 | 83 | |
| 84 | + /*! | |
| 85 | + \brief 再生 | |
| 86 | + | |
| 87 | + 再生長さを指定する frame は １秒あたり 75 の単位系である。 | |
| 88 | + | |
| 89 | + \param track_id [i] 再生するトラック ID | |
| 90 | + \param start_frame [i] 再生開始オフセット位置 [frame] | |
| 91 | + \param play_frame [i] 再生する長さ [frame] | |
| 92 | + \param tracks [i] 再生するトラック数 | |
| 93 | + */ | |
| 80 | 94 | int playTrack(size_t track_id, |
| 81 | 95 | size_t start_frame = 0, |
| 82 | 96 | size_t play_frame = 0, |
| @@ -97,9 +111,24 @@ | ||
| 97 | 111 | size_t* min = NULL, size_t* sec = NULL); |
| 98 | 112 | #endif |
| 99 | 113 | |
| 114 | + /*! | |
| 115 | + \brief 再生の停止 | |
| 116 | + */ | |
| 100 | 117 | void stop(void); |
| 118 | + | |
| 119 | + /*! | |
| 120 | + \brief 再生の一時停止 | |
| 121 | + */ | |
| 101 | 122 | void pause(void); |
| 123 | + | |
| 124 | + /*! | |
| 125 | + \brief 再生の再開 | |
| 126 | + */ | |
| 102 | 127 | void resume(void); |
| 128 | + | |
| 129 | + /*! | |
| 130 | + \brief CD-ROM の取り出し | |
| 131 | + */ | |
| 103 | 132 | void eject(void); |
| 104 | 133 | }; |
| 105 | 134 | }; |
| @@ -145,7 +145,7 @@ | ||
| 145 | 145 | } |
| 146 | 146 | |
| 147 | 147 | |
| 148 | -CdromPlay::CdromPlay(size_t use_drive) : pimpl(new pImpl(use_drive)) { | |
| 148 | +CdromPlay::CdromPlay(size_t drive_id) : pimpl(new pImpl(drive_id)) { | |
| 149 | 149 | } |
| 150 | 150 | |
| 151 | 151 |
| @@ -13,4 +13,4 @@ | ||
| 13 | 13 | cd CdPlayer/ && (if test -f Makefile; then ${MAKE} distclean; fi) |
| 14 | 14 | cd kanjiwar/ && ${MAKE} clean |
| 15 | 15 | cd qpilot/ && ${MAKE} clean |
| 16 | - cd WiiPositionGui/ && (if test -f Makefile; then ${MAKE} distclean; fi) | |
| 16 | + cd WiiPose/ && (if test -f Makefile; then ${MAKE} distclean; fi) |
satofumi