aboutsummaryrefslogtreecommitdiffstats
path: root/src/engine
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
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')
-rw-r--r--src/engine/Engine.cpp4
-rw-r--r--src/engine/SMFDriver.cpp4
-rw-r--r--src/engine/SMFReader.cpp2
-rw-r--r--src/engine/SMFWriter.cpp14
4 files changed, 12 insertions, 12 deletions
diff --git a/src/engine/Engine.cpp b/src/engine/Engine.cpp
index e2f9505..7eeafa4 100644
--- a/src/engine/Engine.cpp
+++ b/src/engine/Engine.cpp
@@ -56,7 +56,7 @@ Engine::new_driver(Forge& forge,
return SPtr<Driver>();
}
-/** Load the machine at @a uri, and run it (replacing current machine).
+/** Load the machine at `uri`, and run it (replacing current machine).
* Safe to call while engine is processing.
*/
SPtr<Machine>
@@ -72,7 +72,7 @@ Engine::load_machine(const Glib::ustring& uri)
return machine;
}
-/** Build a machine from the MIDI at @a uri, and run it (replacing current machine).
+/** Build a machine from the MIDI at `uri`, and run it (replacing current machine).
* Safe to call while engine is processing.
*/
SPtr<Machine>
diff --git a/src/engine/SMFDriver.cpp b/src/engine/SMFDriver.cpp
index f7d1460..a822e7e 100644
--- a/src/engine/SMFDriver.cpp
+++ b/src/engine/SMFDriver.cpp
@@ -39,9 +39,9 @@ SMFDriver::SMFDriver(Forge& forge, Raul::TimeUnit unit)
_writer = SPtr<SMFWriter>(new SMFWriter(unit));
}
-/** Learn a single track from the MIDI file at @a uri
+/** Learn a single track from the MIDI file at `uri`
*
- * @track selects which track of the MIDI file to import, starting from 1.
+ * @param track The track of the MIDI file to import, starting from 1.
*
* Currently only file:// URIs are supported.
* @return the resulting machine.
diff --git a/src/engine/SMFReader.cpp b/src/engine/SMFReader.cpp
index 365a1f3..5df636d 100644
--- a/src/engine/SMFReader.cpp
+++ b/src/engine/SMFReader.cpp
@@ -203,7 +203,7 @@ SMFReader::seek_to_track(unsigned track) throw (std::logic_error)
* Returns event length (including status byte) on success, 0 if event was
* skipped (eg a meta event), or -1 on EOF (or end of track).
*
- * If @a buf is not large enough to hold the event, 0 will be returned, but ev_size
+ * If `buf` is not large enough to hold the event, 0 will be returned, but ev_size
* set to the actual size of the event.
*/
int
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,