diff options
author | Robin Gareus <robin@gareus.org> | 2019-09-30 06:27:24 +0200 |
---|---|---|
committer | Robin Gareus <robin@gareus.org> | 2019-09-30 06:30:11 +0200 |
commit | feb5d1261eb41548e44488bbe67df357b6de9a5f (patch) | |
tree | 01453d48a00f2d52966b76369f0cf79b3ebe110c /libs | |
parent | c7be6f2330d60298cf28a979907d8a5feb433ef1 (diff) |
Fix use of doxygen documented parameters in running text
Diffstat (limited to 'libs')
-rw-r--r-- | libs/ardour/ardour/audio_backend.h | 26 | ||||
-rw-r--r-- | libs/ardour/ardour/audio_buffer.h | 22 | ||||
-rw-r--r-- | libs/ardour/ardour/dsp_filter.h | 2 | ||||
-rw-r--r-- | libs/ardour/ardour/file_source.h | 3 | ||||
-rw-r--r-- | libs/ardour/ardour/lua_api.h | 2 | ||||
-rw-r--r-- | libs/ardour/ardour/port_engine.h | 101 | ||||
-rw-r--r-- | libs/ardour/ardour/processor.h | 4 | ||||
-rw-r--r-- | libs/ardour/ardour/tempo.h | 10 | ||||
-rw-r--r-- | libs/libltc/ltc/ltc.h | 2 | ||||
-rw-r--r-- | libs/pbd/pbd/controllable.h | 2 | ||||
-rw-r--r-- | libs/pbd/pbd/file_utils.h | 2 |
11 files changed, 88 insertions, 88 deletions
diff --git a/libs/ardour/ardour/audio_backend.h b/libs/ardour/ardour/audio_backend.h index 6042a1d6bb..0e47316e4b 100644 --- a/libs/ardour/ardour/audio_backend.h +++ b/libs/ardour/ardour/audio_backend.h @@ -188,7 +188,7 @@ public: return std::vector<std::string> (); } - /** Returns zero if the backend can successfully use \param drivername + /** Returns zero if the backend can successfully use \p drivername * as the driver, non-zero otherwise. * * Should not be used unless the backend returns true from @@ -337,7 +337,7 @@ public: } /** Returns a collection of float identifying sample rates that are - * potentially usable with the hardware identified by \param device . + * potentially usable with the hardware identified by \p device . * Any of these values may be supplied in other calls to this backend * as the desired sample rate to use with the name device, but the * requested sample rate may turn out to be unavailable, or become invalid @@ -372,7 +372,7 @@ public: } /** Returns a collection of uint32 identifying buffer sizes that are - * potentially usable with the hardware identified by \param device . + * potentially usable with the hardware identified by \p device . * Any of these values may be supplied in other calls to this backend * as the desired buffer size to use with the name device, but the * requested buffer size may turn out to be unavailable, or become invalid @@ -406,7 +406,7 @@ public: } /** Returns the maximum number of input channels that are potentially - * usable with the hardware identified by \param device . Any number from 1 + * usable with the hardware identified by \p device . Any number from 1 * to the value returned may be supplied in other calls to this backend as * the input channel count to use with the name device, but the requested * count may turn out to be unavailable, or become invalid at any time. @@ -414,7 +414,7 @@ public: virtual uint32_t available_input_channel_count (const std::string& device) const = 0; /** Returns the maximum number of output channels that are potentially - * usable with the hardware identified by \param device . Any number from 1 + * usable with the hardware identified by \p device . Any number from 1 * to the value returned may be supplied in other calls to this backend as * the output channel count to use with the name device, but the requested * count may turn out to be unavailable, or become invalid at any time. @@ -494,7 +494,7 @@ public: virtual int set_buffer_size (uint32_t) = 0; /** Set the preferred underlying hardware data layout. - * If \param yn is true, then the hardware will interleave + * If \p yn is true, then the hardware will interleave * samples for successive channels; otherwise, the hardware will store * samples for a single channel contiguously. * @@ -588,7 +588,7 @@ public: */ virtual std::vector<std::string> enumerate_midi_options () const = 0; - /* Request the use of the MIDI option named \param option, which + /* Request the use of the MIDI option named \p option, which * should be one of the strings returned by enumerate_midi_options() * * @return zero if successful, non-zero otherwise @@ -676,7 +676,7 @@ public: * unaltered. However, any physical ports should NOT be used by the * process_callback() during freewheeling - the data behaviour is undefined. * - * If \param start_stop is true, begin this behaviour; otherwise cease this + * If \p start_stop is true, begin this behaviour; otherwise cease this * behaviour if it currently occuring, and return to calling * process_callback() of the engine by waiting for the device. * @@ -713,7 +713,7 @@ public: return TransportStopped; } - /** Attempt to locate the transport to \param pos */ + /** Attempt to locate the transport to \p pos */ virtual void transport_locate (samplepos_t pos) {} /** Return the current transport location, in samples measured @@ -724,7 +724,7 @@ public: return 0; } - /** If \param yn is true, become the time master for any inter-application transport + /** If \p yn is true, become the time master for any inter-application transport * timebase, otherwise cease to be the time master for the same. * * Return zero on success, non-zero otherwise @@ -774,11 +774,11 @@ public: /** Return true if it possible to determine the offset in samples of the * first video frame that starts within the current buffer process cycle, * measured from the first sample of the cycle. If returning true, - * set \param offset to that offset. + * set \p offset to that offset. * * Eg. if it can be determined that the first video frame within the cycle * starts 28 samples after the first sample of the cycle, then this method - * should return true and set \param offset to 28. + * should return true and set \p offset to 28. * * May be impossible to support outside of JACK, which has specific support * (in some cases, hardware support) for this feature. @@ -821,7 +821,7 @@ public: virtual void update_latencies () = 0; - /** Set \param speed and \param position to the current speed and position + /** Set \p speed and \p position to the current speed and position * indicated by some transport sync signal. Return whether the current * transport state is pending, or finalized. * diff --git a/libs/ardour/ardour/audio_buffer.h b/libs/ardour/ardour/audio_buffer.h index 7d41777de4..5eba406669 100644 --- a/libs/ardour/ardour/audio_buffer.h +++ b/libs/ardour/ardour/audio_buffer.h @@ -86,7 +86,7 @@ public: _written = true; } - /** Accumulate (add) \param len samples from \param src starting at \param src_offset into self starting at \param dst_offset */ + /** Accumulate (add) \p len samples from \p src starting at \p src_offset into self starting at \p dst_offset */ void merge_from (const Buffer& src, samplecnt_t len, sampleoffset_t dst_offset = 0, sampleoffset_t src_offset = 0) { const AudioBuffer* ab = dynamic_cast<const AudioBuffer*> (&src); @@ -94,7 +94,7 @@ public: accumulate_from (*ab, len, dst_offset, src_offset); } - /** Accumulate (add) \param len samples from \param src starting at \param src_offset into self starting at \param dst_offset */ + /** Accumulate (add) \p len samples from \p src starting at \p src_offset into self starting at \p dst_offset */ void accumulate_from (const AudioBuffer& src, samplecnt_t len, sampleoffset_t dst_offset = 0, sampleoffset_t src_offset = 0) { assert (_capacity > 0); @@ -111,8 +111,8 @@ public: _written = true; } - /** Accumulate (add) \param len samples of \param src starting at \param src_offset into self - * starting at \param dst_offset + /** Accumulate (add) \p len samples of \p src starting at \p src_offset into self + * starting at \p dst_offset */ void accumulate_from (const Sample* src, samplecnt_t len, sampleoffset_t dst_offset = 0, sampleoffset_t src_offset = 0) { @@ -128,8 +128,8 @@ public: _written = true; } - /** Accumulate (add) \param len samples if \param src starting at \param src_offset into self - * starting at \param dst_offset scaling by \param gain_coeff + /** Accumulate (add) \p len samples if \p src starting at \p src_offset into self + * starting at \p dst_offset scaling by \p gain_coeff */ void accumulate_with_gain_from (const AudioBuffer& src, samplecnt_t len, gain_t gain_coeff, sampleoffset_t dst_offset = 0, sampleoffset_t src_offset = 0) { @@ -149,8 +149,8 @@ public: _written = true; } - /** Accumulate (add) \param len samples from the start of \param src_raw into self at \param dst_offset - * scaling by \param gain_coeff + /** Accumulate (add) \p len samples from the start of \p src_raw into self at \p dst_offset + * scaling by \p gain_coeff */ void accumulate_with_gain_from (const Sample* src_raw, samplecnt_t len, gain_t gain_coeff, sampleoffset_t dst_offset = 0) { @@ -165,8 +165,8 @@ public: _written = true; } - /** Accumulate (add) \param len samples from the start of \param src into self at \param dst_offset - * using a linear gain ramp from \param initial to \param target . + /** Accumulate (add) \p len samples from the start of \p src into self at \p dst_offset + * using a linear gain ramp from \p initial to \p target . */ void accumulate_with_ramped_gain_from (const Sample* src, samplecnt_t len, gain_t initial, gain_t target, sampleoffset_t dst_offset = 0) { @@ -219,7 +219,7 @@ public: _written = false; } - /** Reallocate the buffer used internally to handle at least \param nframes of data + /** Reallocate the buffer used internally to handle at least \p nframes of data * * Constructor MUST have been passed capacity!=0 or this will die (to prevent mem leaks). */ diff --git a/libs/ardour/ardour/dsp_filter.h b/libs/ardour/ardour/dsp_filter.h index e557c39808..cb03392913 100644 --- a/libs/ardour/ardour/dsp_filter.h +++ b/libs/ardour/ardour/dsp_filter.h @@ -282,7 +282,7 @@ namespace ARDOUR { namespace DSP { /** query * @param bin the frequency bin 0 .. window_size / 2 - * @param norm gain factor (set equal to \param bin for 1/f normalization) + * @param norm gain factor (set equal to \p bin for 1/f normalization) * @return signal power at given bin (in dBFS) */ float power_at_bin (const uint32_t bin, const float norm = 1.f) const; diff --git a/libs/ardour/ardour/file_source.h b/libs/ardour/ardour/file_source.h index 95464372d1..a5c4111d1c 100644 --- a/libs/ardour/ardour/file_source.h +++ b/libs/ardour/ardour/file_source.h @@ -91,8 +91,7 @@ public: void existence_check (); virtual void prevent_deletion (); - /** Rename the file on disk referenced by this source to \param newname - */ + /** Rename the file on disk referenced by this source to \p newname */ int rename (const std::string& name); virtual void close () = 0; diff --git a/libs/ardour/ardour/lua_api.h b/libs/ardour/ardour/lua_api.h index 1407b3cd3b..3ae76f8e5b 100644 --- a/libs/ardour/ardour/lua_api.h +++ b/libs/ardour/ardour/lua_api.h @@ -251,7 +251,7 @@ namespace ARDOUR { namespace LuaAPI { * * If the plugin is not yet initialized, initialize() is called. * - * if \param fn is not nil, it is called with the immediate + * if \p fn is not nil, it is called with the immediate * Vamp::Plugin::Features on every process call. * * @param r readable diff --git a/libs/ardour/ardour/port_engine.h b/libs/ardour/ardour/port_engine.h index 71f31cb3c3..483206578a 100644 --- a/libs/ardour/ardour/port_engine.h +++ b/libs/ardour/ardour/port_engine.h @@ -124,7 +124,7 @@ public: /** Query port-flags * * @param port \ref PortHandle - * @return the flags of the port referred to by \param port . If the port + * @return the flags of the port referred to by \p port . If the port * does not exist, return PortFlags (0) */ virtual PortFlags get_port_flags (PortHandle port) const = 0; @@ -159,7 +159,7 @@ public: */ virtual int set_port_property (PortHandle, const std::string& key, const std::string& value, const std::string& type) { return -1; } - /** Return a reference to a port with the fullname \param name . + /** Return a reference to a port with the fullname \p name . * * @param name Full port-name to lookup * @return PortHandle if lookup was successful, or an "empty" PortHandle (analogous to a null pointer) if no such port exists. @@ -167,11 +167,12 @@ public: virtual PortHandle get_port_by_name (const std::string& name) const = 0; /** Find the set of ports whose names, types and flags match - * specified values, place the names of each port into \param ports . + * specified values, place the names of each port into \p ports . * * @param port_name_pattern match by given pattern. To avoid selecting by name, pass an empty string. * @param type filter by given type; pass DataType::NIL to match all types. * @param flags filter by flags, pass PortFlags (0) to avoid selecting by flags. + * @param ports array filled with matching port-names * @return the count of the number found */ virtual int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>& ports) const = 0; @@ -179,14 +180,14 @@ public: /** Lookup data type of a port * * @param port \ref PortHandle of the port to lookup. - * @return the Ardour data type handled by the port referred to by \param port . + * @return the Ardour data type handled by the port referred to by \p port . * DataType::NIL is returned if the port does not exist. */ virtual DataType port_data_type (PortHandle port) const = 0; /** Create a new port whose fullname will be the conjunction of my_name(), - * ":" and \param shortname . The port will handle data specified by \param type - * and will have the flags given by \param flags . If successful, + * ":" and \p shortname . The port will handle data specified by \p type + * and will have the flags given by \p flags . If successful, * * @param shortname Name of port to create * @param type type of port to create @@ -195,8 +196,8 @@ public: */ virtual PortHandle register_port (const std::string& shortname, ARDOUR::DataType type, ARDOUR::PortFlags flags) = 0; - /* Destroy the port referred to by \param port, including all resources - * associated with it. This will also disconnect \param port from any ports it + /* Destroy the port referred to by \p port, including all resources + * associated with it. This will also disconnect \p port from any ports it * is connected to. * * @param port \ref PortHandle of the port to destroy @@ -205,8 +206,8 @@ public: /* Connection management */ - /** Ensure that data written to the port named by \param src will be - * readable from the port named by \param dst + /** Ensure that data written to the port named by \p src will be + * readable from the port named by \p dst * * @param src name of source port to connect * @param dst name of destination (sink) port @@ -214,8 +215,8 @@ public: */ virtual int connect (const std::string& src, const std::string& dst) = 0; - /** Remove any existing connection between the ports named by \param src and - * \param dst + /** Remove any existing connection between the ports named by \p src and + * \p dst * * @param src name of source port to dis-connect to disconnect from * @param dst name of destination (sink) port to disconnect @@ -223,8 +224,8 @@ public: */ virtual int disconnect (const std::string& src, const std::string& dst) = 0; - /** Ensure that data written to the port referenced by \param src will be - * readable from the port named by \param dst + /** Ensure that data written to the port referenced by \p src will be + * readable from the port named by \p dst * * @param src \ref PortHandle of source port to connect * @param dst \ref PortHandle of destination (sink) port @@ -232,8 +233,8 @@ public: */ virtual int connect (PortHandle src, const std::string& dst) = 0; - /** Remove any existing connection between the port referenced by \param src and - * the port named \param dst + /** Remove any existing connection between the port referenced by \p src and + * the port named \p dst * * @param src \ref PortHandle of source port to disconnect from * @param dst \ref PortHandle of destination (sink) port to disconnect @@ -241,7 +242,7 @@ public: */ virtual int disconnect (PortHandle src, const std::string& dst) = 0; - /** Remove all connections between the port referred to by \param port and + /** Remove all connections between the port referred to by \p port and * any other ports. * * @param port \ref PortHandle of port to disconnect @@ -249,11 +250,11 @@ public: */ virtual int disconnect_all (PortHandle port) = 0; - /** Test if given \param port is connected + /** Test if given \p port is connected * * @param port \ref PortHandle of port to test * @param process_callback_safe true if this method is not called from rt-context of backend callbacks - * @return true if the port referred to by \param port has any connections to other ports. Return false otherwise. + * @return true if the port referred to by \p port has any connections to other ports. Return false otherwise. */ virtual bool connected (PortHandle port, bool process_callback_safe = true) = 0; @@ -262,24 +263,24 @@ public: * @param port \ref PortHandle of source port to test * @param name name of destination to test * @param process_callback_safe true if this method is not called from rt-context of backend callbacks - * @return true if the port referred to by \param port is connected to the port named by \param name . Return false otherwise. + * @return true if the port referred to by \p port is connected to the port named by \p name . Return false otherwise. */ virtual bool connected_to (PortHandle port, const std::string& name, bool process_callback_safe = true) = 0; - /** Test if given \param port is is connected to physical I/O ports. + /** Test if given \p port is is connected to physical I/O ports. * * @param port \ref PortHandle of source port to test * @param process_callback_safe true if this method is not called from rt-context of backend callbacks - * @return true if the port referred to by \param port has any connections + * @return true if the port referred to by \p port has any connections * to ports marked with the PortFlag IsPhysical. Return false otherwise. */ virtual bool physically_connected (PortHandle port, bool process_callback_safe = true) = 0; - /** Test if given \param port is has external connections. + /** Test if given \p port is has external connections. * * @param port \ref PortHandle of port to test * @param process_callback_safe true if this method is not called from rt-context of backend callbacks - * @return true if the port referred to by \param port has any connections + * @return true if the port referred to by \p port has any connections * to external, not-ardour owned, ports. */ virtual bool externally_connected (PortHandle port, bool process_callback_safe = true) { @@ -288,7 +289,7 @@ public: } /** Place the names of all ports connected to the port named by - * \param port into \param names . + * \p port into \p names . * * @param port \ref PortHandle * @param names array or returned port-names @@ -299,17 +300,17 @@ public: /* MIDI */ - /** Retrieve a MIDI event from the data at \param port_buffer . The event - * number to be retrieved is given by \param event_index (a value of zero + /** Retrieve a MIDI event from the data at \p port_buffer . The event + * number to be retrieved is given by \p event_index (a value of zero * indicates that the first event in the port_buffer should be retrieved). * * The data associated with the event will be copied into the buffer at - * \param buf and the number of bytes written will be stored in \param size . + * \p buf and the number of bytes written will be stored in \p size . * The timestamp of the event (which is always relative to the start - * of the current process cycle, in samples) will be stored in \param timestamp . + * of the current process cycle, in samples) will be stored in \p timestamp . * * @param timestamp time in samples relative to the current cycle start - * @param size number of bytes read into \param buf + * @param size number of bytes read into \p buf * @param buf raw MIDI data * @param port_buffer the midi-port buffer * @param event_index index of event to retrieve @@ -317,9 +318,9 @@ public: */ virtual int midi_event_get (pframes_t& timestamp, size_t& size, uint8_t const** buf, void* port_buffer, uint32_t event_index) = 0; - /** Place a MIDI event consisting of \param size bytes copied from the data - * at \param buffer into the port buffer referred to by \param port_buffer . - * The MIDI event will be marked with a time given by \param timestamp . + /** Place a MIDI event consisting of \p size bytes copied from the data + * at \p buffer into the port buffer referred to by \p port_buffer . + * The MIDI event will be marked with a time given by \p timestamp . * * Events must be added monotonically to a port buffer. An attempt to * add a non-monotonic event (e.g. out-of-order) will cause this method @@ -328,22 +329,22 @@ public: * @param port_buffer the midi-port buffer * @param timestamp time in samples relative to the current cycle start * @param buffer raw MIDI data to emplace - * @param size number of bytes of \param buffer + * @param size number of bytes of \p buffer * @return zero on success, non-zero otherwise. */ virtual int midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size) = 0; - /** Query the number of MIDI events in the data at \param port_buffer + /** Query the number of MIDI events in the data at \p port_buffer * * @param port_buffer the midi-port buffer - * @return the number of MIDI events in the data at \param port_buffer + * @return the number of MIDI events in the data at \p port_buffer */ virtual uint32_t get_midi_event_count (void* port_buffer) = 0; - /** Clear the buffer at \param port_buffer of all MIDI events. + /** Clear the buffer at \p port_buffer of all MIDI events. * * After a call to this method, an immediate, subsequent call to - * \ref get_midi_event_count with the same \param port_buffer argument must + * \ref get_midi_event_count with the same \p port_buffer argument must * return zero. * * @param port_buffer the buffer to clear @@ -364,7 +365,7 @@ public: /** Increment or decrement the number of requests to monitor the input * of the hardware channel represented by the port referred to by - * \param port . + * \p port . * * If the number of requests rises above zero, input monitoring will * be enabled (if can_monitor_input() returns true for the implementation). @@ -379,9 +380,9 @@ public: virtual int request_input_monitoring (PortHandle port, bool yn) = 0; /* Force input monitoring of the hardware channel represented by the port - * referred to by \param port to be on or off, depending on the true/false - * status of \param yn. The request count is ignored when using this - * method, so if this is called with \param yn set to false, input monitoring will + * referred to by \p port to be on or off, depending on the true/false + * status of \p yn. The request count is ignored when using this + * method, so if this is called with \p yn set to false, input monitoring will * be disabled regardless of the number of requests to enable it. * * @param port \ref PortHandle @@ -390,19 +391,19 @@ public: */ virtual int ensure_input_monitoring (PortHandle port, bool yn) = 0; - /** Query status of hardware monitoring for given \param port + /** Query status of hardware monitoring for given \p port * * @param port \ref PortHandle to test * @return true if input monitoring is enabled for the hardware channel - * represented by the port referred to by \param port . + * represented by the port referred to by \p port . * Return false otherwise. */ virtual bool monitoring_input (PortHandle port) = 0; /* Latency management */ - /** Set the latency range for the port referred to by \param port to - * \param r . The playback range will be set if \param for_playback is true, + /** Set the latency range for the port referred to by \p port to + * \p r . The playback range will be set if \p for_playback is true, * otherwise the capture range will be set. * * @param port \ref PortHandle to operate on @@ -414,7 +415,7 @@ public: */ virtual void set_latency_range (PortHandle port, bool for_playback, LatencyRange r) = 0; - /** Return the latency range for the port referred to by \param port . + /** Return the latency range for the port referred to by \p port . * The playback range will be returned if @param for_playback is true, * otherwise the capture range will be returned. * @@ -426,15 +427,15 @@ public: /* Discovering physical ports */ - /** Return true if the port referred to by \param port has the IsPhysical + /** Return true if the port referred to by \p port has the IsPhysical * flag set. Return false otherwise. * * @param port \ref PortHandle to query */ virtual bool port_is_physical (PortHandle port) const = 0; - /** Store into \param names the names of all ports with the IsOutput and - * IsPhysical flag set, that handle data of type \param type . + /** Store into \p names the names of all ports with the IsOutput and + * IsPhysical flag set, that handle data of type \p type . * * This can be used to discover outputs associated with hardware devices. * diff --git a/libs/ardour/ardour/processor.h b/libs/ardour/ardour/processor.h index e0b797b1b8..745702e0c1 100644 --- a/libs/ardour/ardour/processor.h +++ b/libs/ardour/ardour/processor.h @@ -92,10 +92,10 @@ class LIBARDOUR_API Processor : public SessionObject, public Automatable, public * * @param bufs bufferset of data to process in-place * @param start_sample absolute timeline position in audio-samples to commence processing (latency compensated) - * @param end_sample absolute timeline position in audio-samples, usually start_sample +/- \param nframes + * @param end_sample absolute timeline position in audio-samples, usually start_sample +/- \p nframes * @param speed transport speed. usually -1, 0, +1 * @param nframes number of audio samples to process - * @param result_required true if, on return from this method, \param bufs is required to contain valid data; + * @param result_required true if, on return from this method, \p bufs is required to contain valid data; * if false, the method need not bother writing to @a bufs if it doesn't want to. */ virtual void run (BufferSet& bufs, samplepos_t start_sample, samplepos_t end_sample, double speed, pframes_t nframes, bool result_required) {} diff --git a/libs/ardour/ardour/tempo.h b/libs/ardour/ardour/tempo.h index 9e5124f1af..c0132fc085 100644 --- a/libs/ardour/ardour/tempo.h +++ b/libs/ardour/ardour/tempo.h @@ -389,18 +389,18 @@ class LIBARDOUR_API TempoMap : public PBD::StatefulDestructible TempoSection* next_tempo_section (TempoSection*) const; /** add a tempo section locked to pls. ignored values will be set in recompute_tempi() - * @param pulse pulse position of new section. ignored if \param pls == AudioTime - * @param sample frame position of new section. ignored if \param pls == MusicTime + * @param pulse pulse position of new section. ignored if \p pls == AudioTime + * @param sample frame position of new section. ignored if \p pls == MusicTime * @param pls the position lock style */ TempoSection* add_tempo (const Tempo&, const double& pulse, const samplepos_t sample, PositionLockStyle pls); - /** add a meter section locked to \param pls . ignored values will be set in recompute_meters() + /** add a meter section locked to \p pls . ignored values will be set in recompute_meters() * @param meter the Meter to be added * @param where bbt position of new section - * @param sample frame position of new section. ignored if \param pls == MusicTime + * @param sample frame position of new section. ignored if \p pls == MusicTime * - * note that \param sample may also be ignored if it would create an un-solvable map + * note that \p sample may also be ignored if it would create an un-solvable map * (previous audio-locked tempi may place the requested beat at an earlier time than sample) * in which case the new meter will be placed at the specified BBT. * @param pls the position lock style diff --git a/libs/libltc/ltc/ltc.h b/libs/libltc/ltc/ltc.h index 5abbfa0607..e354996432 100644 --- a/libs/libltc/ltc/ltc.h +++ b/libs/libltc/ltc/ltc.h @@ -431,7 +431,7 @@ int ltc_decoder_free(LTCDecoder *d); * @param d decoder handle * @param buf pointer to ltcsnd_sample_t - unsigned 8 bit mono audio data * @param size size number of samples to parse - * @param posinfo (optional, recommended) sample-offset in the audio-stream. It is added to \ref off_start, \ref off_end in \ref LTCFrameExt and should be monotonic (ie incremented by \param size for every call to ltc_decoder_write) + * @param posinfo (optional, recommended) sample-offset in the audio-stream. It is added to \ref off_start, \ref off_end in \ref LTCFrameExt and should be monotonic (ie incremented by \p size for every call to ltc_decoder_write) */ void ltc_decoder_write(LTCDecoder *d, ltcsnd_sample_t *buf, size_t size, diff --git a/libs/pbd/pbd/controllable.h b/libs/pbd/pbd/controllable.h index 8473147336..62127fb048 100644 --- a/libs/pbd/pbd/controllable.h +++ b/libs/pbd/pbd/controllable.h @@ -96,7 +96,7 @@ public: * * All derived classes must implement this. * - * Basic derived classes will ignore \param group_override + * Basic derived classes will ignore \p group_override * but more sophisticated children, notably those that * proxy the value setting logic via an object that is aware of group * relationships between this control and others, will find it useful. diff --git a/libs/pbd/pbd/file_utils.h b/libs/pbd/pbd/file_utils.h index 46e3ab1849..29bb491511 100644 --- a/libs/pbd/pbd/file_utils.h +++ b/libs/pbd/pbd/file_utils.h @@ -268,7 +268,7 @@ LIBPBD_API void remove_directory (const std::string& dir); */ LIBPBD_API std::string tmp_writable_directory (const char* domain, const std::string& prefix); -/** If \param path exists, unlink it. If it doesn't exist, create it. +/** If \p path exists, unlink it. If it doesn't exist, create it. * * @return zero if required action was successful, non-zero otherwise. */ |