Documentation enhancements to improve documentation cross-references.
This commit is contained in:
		
							parent
							
								
									6865a7bc09
								
							
						
					
					
						commit
						9cec85bfd9
					
				
					 22 changed files with 425 additions and 241 deletions
				
			
		| 
						 | 
				
			
			@ -79,7 +79,7 @@
 | 
			
		|||
			#if defined(__DOXYGEN__)
 | 
			
		||||
				/** Determines the currently selected dataflash chip.
 | 
			
		||||
				 *
 | 
			
		||||
				 *  \return Mask of the currently selected Dataflash chip, either DATAFLASH_NO_CHIP if no chip is selected
 | 
			
		||||
				 *  \return Mask of the currently selected Dataflash chip, either \ref DATAFLASH_NO_CHIP if no chip is selected
 | 
			
		||||
				 *  or a DATAFLASH_CHIPn mask (where n is the chip number).
 | 
			
		||||
				 */
 | 
			
		||||
				static inline uint8_t Dataflash_GetSelectedChip(void);
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -76,10 +76,10 @@
 | 
			
		|||
			/** ADC channel number for the temperature sensor. */
 | 
			
		||||
			#define TEMP_ADC_CHANNEL   0
 | 
			
		||||
			
 | 
			
		||||
			/** Minimum returnable temperature from the Temperature_GetTemperature() function. */
 | 
			
		||||
			/** Minimum returnable temperature from the \ref Temperature_GetTemperature() function. */
 | 
			
		||||
			#define TEMP_MIN_TEMP      TEMP_TABLE_OFFSET
 | 
			
		||||
 | 
			
		||||
			/** Maximum returnable temperature from the Temperature_GetTemperature() function. */
 | 
			
		||||
			/** Maximum returnable temperature from the \ref Temperature_GetTemperature() function. */
 | 
			
		||||
			#define TEMP_MAX_TEMP      ((TEMP_TABLE_SIZE - 1) + TEMP_TABLE_OFFSET)
 | 
			
		||||
		
 | 
			
		||||
		/* Pseudo-Function Macros: */
 | 
			
		||||
| 
						 | 
				
			
			@ -97,7 +97,7 @@
 | 
			
		|||
 | 
			
		||||
		/* Function Prototypes: */
 | 
			
		||||
			/** Performs a complete ADC on the temperature sensor channel, and converts the result into a
 | 
			
		||||
			 *  valid temperature between TEMP_MIN_TEMP and TEMP_MAX_TEMP in degrees Celsius.
 | 
			
		||||
			 *  valid temperature between \ref TEMP_MIN_TEMP and \ref TEMP_MAX_TEMP in degrees Celsius.
 | 
			
		||||
			 *
 | 
			
		||||
			 *  \return Signed temperature in degrees Celsius
 | 
			
		||||
			 */
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue