mirror of
				https://github.com/PabloMK7/citra.git
				synced 2025-10-30 21:30:04 +00:00 
			
		
		
		
	Doxygen: Amend minor issues (#2593)
Corrects a few issues with regards to Doxygen documentation, for example: - Incorrect parameter referencing. - Missing @param tags. - Typos in @param tags. and a few minor other issues.
This commit is contained in:
		
							parent
							
								
									b250ce21b9
								
							
						
					
					
						commit
						0cb52ee74a
					
				
					 18 changed files with 31 additions and 23 deletions
				
			
		|  | @ -27,7 +27,7 @@ public: | |||
|      * See also: SourceConfiguration::Configuration::simple_filter_enabled, | ||||
|      *           SourceConfiguration::Configuration::biquad_filter_enabled. | ||||
|      * @param simple If true, enables the simple filter. If false, disables it. | ||||
|      * @param simple If true, enables the biquad filter. If false, disables it. | ||||
|      * @param biquad If true, enables the biquad filter. If false, disables it. | ||||
|      */ | ||||
|     void Enable(bool simple, bool biquad); | ||||
| 
 | ||||
|  |  | |||
|  | @ -21,6 +21,7 @@ struct State { | |||
| 
 | ||||
| /**
 | ||||
|  * No interpolation. This is equivalent to a zero-order hold. There is a two-sample predelay. | ||||
|  * @param state Interpolation state. | ||||
|  * @param input Input buffer. | ||||
|  * @param rate_multiplier Stretch factor. Must be a positive non-zero value. | ||||
|  *                        rate_multiplier > 1.0 performs decimation and rate_multipler < 1.0 | ||||
|  | @ -31,6 +32,7 @@ StereoBuffer16 None(State& state, const StereoBuffer16& input, float rate_multip | |||
| 
 | ||||
| /**
 | ||||
|  * Linear interpolation. This is equivalent to a first-order hold. There is a two-sample predelay. | ||||
|  * @param state Interpolation state. | ||||
|  * @param input Input buffer. | ||||
|  * @param rate_multiplier Stretch factor. Must be a positive non-zero value. | ||||
|  *                        rate_multiplier > 1.0 performs decimation and rate_multipler < 1.0 | ||||
|  |  | |||
|  | @ -34,7 +34,7 @@ public: | |||
| 
 | ||||
|     /**
 | ||||
|      * Sets the desired output device. | ||||
|      * @paran device_id Id of the desired device. | ||||
|      * @param device_id ID of the desired device. | ||||
|      */ | ||||
|     virtual void SetDevice(int device_id) = 0; | ||||
| 
 | ||||
|  |  | |||
|  | @ -25,7 +25,7 @@ public: | |||
|     /**
 | ||||
|      * Add samples to be processed. | ||||
|      * @param sample_buffer Buffer of samples in interleaved stereo PCM16 format. | ||||
|      * @param num_sample Number of samples. | ||||
|      * @param num_samples Number of samples. | ||||
|      */ | ||||
|     void AddSamples(const s16* sample_buffer, size_t num_samples); | ||||
| 
 | ||||
|  |  | |||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue