aboutsummaryrefslogtreecommitdiffstats
path: root/src/engine/SMFWriter.cpp
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2014-08-08 14:46:53 +0000
committerDavid Robillard <d@drobilla.net>2014-08-08 14:46:53 +0000
commit1afc11f63b596a03faab2f8802e662e2d1607d0a (patch)
treee9b2feda1f2be27c961fe4a7d45bce39cf2deba1 /src/engine/SMFWriter.cpp
parentadd7bc7f682037aea8f97f7c40b8302f94f962d0 (diff)
downloadmachina-1afc11f63b596a03faab2f8802e662e2d1607d0a.tar.gz
machina-1afc11f63b596a03faab2f8802e662e2d1607d0a.tar.bz2
machina-1afc11f63b596a03faab2f8802e662e2d1607d0a.zip
Use Markdown in doc comments for better source readability.
git-svn-id: http://svn.drobilla.net/lad/trunk/machina@5429 a436a847-0d15-0410-975c-d299462d15a1
Diffstat (limited to 'src/engine/SMFWriter.cpp')
-rw-r--r--src/engine/SMFWriter.cpp14
1 files changed, 7 insertions, 7 deletions
diff --git a/src/engine/SMFWriter.cpp b/src/engine/SMFWriter.cpp
index f632bca..9d18d46 100644
--- a/src/engine/SMFWriter.cpp
+++ b/src/engine/SMFWriter.cpp
@@ -32,7 +32,7 @@ namespace machina {
/** Create a new SMF writer.
*
- * @a unit must match the time stamp of ALL events passed to write, or
+ * @param unit Must match the time stamp of ALL events passed to write, or
* terrible things will happen.
*
* *** NOTE: Only beat time is implemented currently.
@@ -59,9 +59,9 @@ SMFWriter::~SMFWriter()
/** Start a write to an SMF file.
*
- * @a filename Filename to write to.
- * @a start_time Beat time corresponding to t=0 in the file (timestamps passed
- * to write_event will have this value subtracted before writing).
+ * @param filename Filename to write to.
+ * @param start_time Beat time corresponding to t=0 in the file (timestamps
+ * passed to write_event will have this value subtracted before writing).
*/
bool
SMFWriter::start(const std::string& filename,
@@ -90,9 +90,9 @@ SMFWriter::start(const std::string& filename,
/** Write an event at the end of the file.
*
- * @a time is the absolute time of the event, relative to the start of the file
- * (the start_time parameter to start). Must be monotonically increasing on
- * successive calls to this method.
+ * @param time The absolute time of the event, relative to the start of the
+ * file (the start_time parameter to start). Must be monotonically increasing
+ * on successive calls to this method.
*/
void
SMFWriter::write_event(Raul::TimeStamp time,