No more doxygen warnings for gtk2_arodur/*
That's with doxgen 1.8.13.
This commit is contained in:
parent
feb5d1261e
commit
0a6f517230
|
@ -158,7 +158,7 @@ protected:
|
|||
};
|
||||
|
||||
std::vector<ArdourWaveView::WaveView *> waves;
|
||||
std::vector<ArdourWaveView::WaveView *> tmp_waves; ///< see ::create_waves()
|
||||
std::vector<ArdourWaveView::WaveView *> tmp_waves; ///< see \ref create_waves()
|
||||
|
||||
std::list<std::pair<samplepos_t, ArdourCanvas::Line*> > feature_lines;
|
||||
|
||||
|
|
|
@ -131,7 +131,7 @@ public:
|
|||
void revert_to_default_display ();
|
||||
|
||||
/** @return the delivery that is being edited using our fader; it will be the
|
||||
* last send passed to ::show_send, or our route's main out delivery.
|
||||
* last send passed to show_send(), or our route's main out delivery.
|
||||
*/
|
||||
boost::shared_ptr<ARDOUR::Delivery> current_delivery () const {
|
||||
return _current_delivery;
|
||||
|
|
|
@ -49,8 +49,12 @@ public:
|
|||
|
||||
void set_session (ARDOUR::Session *);
|
||||
|
||||
/** @param g Route group, or 0.
|
||||
* @return Menu to be popped up on right-click over the given route group.
|
||||
/** Create route-group context menu
|
||||
*
|
||||
* @param g Route group, or 0.
|
||||
* @param tabArea false if context menu is not for a group tab, show the "create new from" items here.
|
||||
* When true a given group's context menu for the group \p g is displayed.
|
||||
* @return Menu to be popped up on right-click over the given route group.
|
||||
*/
|
||||
Gtk::Menu* get_menu (ARDOUR::RouteGroup* g, bool tabArea = false);
|
||||
|
||||
|
@ -85,11 +89,12 @@ private:
|
|||
*/
|
||||
virtual void draw_tab (cairo_t* cr, Tab const & t) = 0;
|
||||
|
||||
/** @param x x coordinate
|
||||
* @param y y coordinate
|
||||
* @return x or y, depending on which is the primary coordinate for this widget.
|
||||
/** Coordinate map (editor, mixer)
|
||||
* @param x x-coordinate
|
||||
* @param y y-coordinate
|
||||
* @return x or y, depending on which is the primary coordinate for this widget.
|
||||
*/
|
||||
virtual double primary_coordinate (double, double) const = 0;
|
||||
virtual double primary_coordinate (double x, double y) const = 0;
|
||||
|
||||
virtual ARDOUR::RouteList routes_for_tab (Tab const * t) const = 0;
|
||||
|
||||
|
|
|
@ -161,6 +161,8 @@ public:
|
|||
void delete_sysex (SysEx*);
|
||||
|
||||
/** Change a patch to the next or previous bank/program.
|
||||
*
|
||||
* @param patch The patch-change instance (canvas item)
|
||||
* @param bank If true, step bank, otherwise, step program.
|
||||
* @param delta Amount to adjust number.
|
||||
*/
|
||||
|
@ -216,8 +218,11 @@ public:
|
|||
void select_matching_notes (uint8_t notenum, uint16_t channel_mask, bool add, bool extend);
|
||||
void toggle_matching_notes (uint8_t notenum, uint16_t channel_mask);
|
||||
|
||||
/** Return true iff the note is within the extent of the region.
|
||||
/** Test if a note is within this region's range
|
||||
*
|
||||
* @param note the note to test
|
||||
* @param visible will be set to true if the note is within the visible note range, false otherwise.
|
||||
* @return true iff the note is within the (time) extent of the region.
|
||||
*/
|
||||
bool note_in_region_range(const boost::shared_ptr<NoteType> note, bool& visible) const;
|
||||
|
||||
|
|
|
@ -111,7 +111,7 @@ public:
|
|||
void revert_to_default_display ();
|
||||
|
||||
/** @return the delivery that is being edited using our fader; it will be the
|
||||
* last send passed to ::show_send, or our route's main out delivery.
|
||||
* last send passed to \ref show_send() , or our route's main out delivery.
|
||||
*/
|
||||
boost::shared_ptr<ARDOUR::Delivery> current_delivery () const {
|
||||
return _current_delivery;
|
||||
|
|
|
@ -191,10 +191,13 @@ public:
|
|||
/** @return Whether the current mouse mode is an "internal" editing mode. */
|
||||
virtual bool internal_editing() const = 0;
|
||||
|
||||
/** Possibly start the audition of a region. If @param r is 0, or not an AudioRegion
|
||||
* any current audition is cancelled. If we are currently auditioning @param r,
|
||||
* the audition will be cancelled. Otherwise an audition of @param r will start.
|
||||
* \param r Region to consider.
|
||||
/** Possibly start the audition of a region.
|
||||
*
|
||||
* If \p r is 0, or not an AudioRegion any current audition is cancelled.
|
||||
* If we are currently auditioning \p r , the audition will be cancelled.
|
||||
* Otherwise an audition of \p r will start.
|
||||
*
|
||||
* @param r Region to consider auditioning
|
||||
*/
|
||||
virtual void consider_auditioning (boost::shared_ptr<ARDOUR::Region> r) = 0;
|
||||
|
||||
|
|
|
@ -188,6 +188,7 @@ public:
|
|||
* @param pos Position to paste to (session samples).
|
||||
* @param selection Selection to paste.
|
||||
* @param ctx Paste context.
|
||||
* @param sub_num music-time sub-division: \c -1: snap to bar, \c 1: exact beat, \c >1: \c (1 \c / \p sub_num \c ) beat-divisions
|
||||
*/
|
||||
virtual bool paste (ARDOUR::samplepos_t pos,
|
||||
const Selection& selection,
|
||||
|
|
|
@ -48,19 +48,21 @@ class TranscodeFfmpeg : public sigc::trackable
|
|||
/** instantiate a new transcoder. If a file-name is given, the file's
|
||||
* attributes (fps, duration, geometry etc) are read.
|
||||
*
|
||||
* @param f path to the video-file to probe or use as input for
|
||||
* \ref extract_audio and \ref transcode.
|
||||
* @param f path to the video-file to probe or use as input for \ref extract_audio and \ref transcode .
|
||||
*/
|
||||
TranscodeFfmpeg (std::string f);
|
||||
virtual ~TranscodeFfmpeg ();
|
||||
/** transcode/import a video-file
|
||||
* @param outfile full-path (incl. file-extension)
|
||||
* @param outwidth video-width, \c <0 no scaling)
|
||||
* @param outheight video-height \c <0 use aspect \c \ref outwidth /c / \c aspect-ratio
|
||||
* @param kbitps video bitrate \c 0 calculate to use 0.7 bits per pixel on average
|
||||
|
||||
/** transcode to (import a video-file)
|
||||
*
|
||||
* @param outfile full-path (incl. file-extension) of the file to create
|
||||
* @param width video-width, if \c <0 no scaling
|
||||
* @param height video-height, with \c <0 preserve aspect (\p width \c / \c aspect-ratio)
|
||||
* @param kbitps video bitrate, with \c 0 calculate to use 0.7 bits per pixel on average
|
||||
* @return \c true if the transcoder process was successfully started.
|
||||
*/
|
||||
bool transcode (std::string, const int outwidth=0, const int outheight=0, const int kbitps =0);
|
||||
bool transcode (std::string outfile, const int width=0, const int height=0, const int kbitps =0);
|
||||
|
||||
/** Extract an audio track from the given input file to a new 32bit float little-endian PCM WAV file.
|
||||
* @param outfile full-path (incl. file-extension) to .wav file to write
|
||||
* @param samplerate target samplerate
|
||||
|
@ -69,6 +71,7 @@ class TranscodeFfmpeg : public sigc::trackable
|
|||
* @return \c true if the transcoder process was successfully started.
|
||||
*/
|
||||
bool extract_audio (std::string outfile, ARDOUR::samplecnt_t samplerate, unsigned int stream=0);
|
||||
|
||||
/** transcode video and mux audio files into a new video-file.
|
||||
* @param outfile full-path of output file to create (existing files are overwritten)
|
||||
* @param inf_a filename of input audio-file
|
||||
|
@ -82,6 +85,7 @@ class TranscodeFfmpeg : public sigc::trackable
|
|||
* @return \c true if the encoder process was successfully started.
|
||||
*/
|
||||
bool encode (std::string outfile, std::string inf_a, std::string inf_v, FFSettings ffs, FFSettings meta, bool map = true);
|
||||
|
||||
/** @return array with default encoder settings */
|
||||
FFSettings default_encoder_settings ();
|
||||
/** @return array with default meta data */
|
||||
|
|
Loading…
Reference in New Issue
Block a user