smokephil/ardour
1
0
Fork 0
mirror of https://github.com/Ardour/ardour.git synced 2025-12-06 06:44:57 +01:00
Code Issues Projects Releases Wiki Activity

Fix invalid use of Doxygen "@param" command

Browse source 
This is never for inline references to parameters, only for starting parameter
documentation blocks.  The "@p" command is for this, although unfortunately
Doxygen doesn't actually do anything with it and it's just an alias for code
text.
This commit is contained in:
David Robillard 2022-10-30 20:44:28 -04:00
parent 96bab3ce46
commit bdacfb8724
31 changed files with 68 additions and 65 deletions
Download patch file Download diff file Expand all files Collapse all files

13
gtk2_ardour/editor.cc
View file

@ -2701,13 +2701,16 @@ Editor::get_state () const
return *node;
}
/** if @param trackview_relative_offset is true, @param y y is an offset into the trackview area, in pixel units
* if @param trackview_relative_offset is false, @param y y is a global canvas * coordinate, in pixel units
/** Find a TimeAxisView by y position.
*
* @return pair: TimeAxisView that y is over, layer index.
* TimeAxisView may be 0. Layer index is the layer number if the TimeAxisView
* is valid and is in stacked or expanded region display mode, otherwise 0.
*
* TimeAxisView may be 0. Layer index is the layer number if the TimeAxisView is valid and is
* in stacked or expanded region display mode, otherwise 0.
* If @p trackview_relative_offset is true, then @p y is an offset into the
* trackview area. Otherwise, @p y is a global canvas coordinate. In both
* cases, @p y is in pixels.
*
* @return The TimeAxisView that @p y is over, and the layer index.
*/
std::pair<TimeAxisView *, double>
Editor::trackview_by_y_position (double y, bool trackview_relative_offset) const