updated the Doxygen configuration file and readme
This commit is contained in:
		
							parent
							
								
									2f15937b4b
								
							
						
					
					
						commit
						8ffbe8ab54
					
				
					 2 changed files with 16 additions and 2 deletions
				
			
		
							
								
								
									
										4
									
								
								Doxyfile
									
										
									
									
									
								
							
							
						
						
									
										4
									
								
								Doxyfile
									
										
									
									
									
								
							| 
						 | 
				
			
			@ -949,7 +949,7 @@ WARN_LOGFILE           =
 | 
			
		|||
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 | 
			
		||||
# Note: If this tag is empty the current directory is searched.
 | 
			
		||||
 | 
			
		||||
INPUT                  = ./src
 | 
			
		||||
INPUT                  = ./src/ 
 | 
			
		||||
 | 
			
		||||
# This tag can be used to specify the character encoding of the source files
 | 
			
		||||
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
 | 
			
		||||
| 
						 | 
				
			
			@ -1045,7 +1045,7 @@ FILE_PATTERNS          = *.c \
 | 
			
		|||
# be searched for input files as well.
 | 
			
		||||
# The default value is: NO.
 | 
			
		||||
 | 
			
		||||
RECURSIVE              = NO
 | 
			
		||||
RECURSIVE              = YES
 | 
			
		||||
 | 
			
		||||
# The EXCLUDE tag can be used to specify files and/or directories that should be
 | 
			
		||||
# excluded from the INPUT source files. This way you can easily exclude a
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
							
								
								
									
										14
									
								
								README.md
									
										
									
									
									
								
							
							
						
						
									
										14
									
								
								README.md
									
										
									
									
									
								
							| 
						 | 
				
			
			@ -7,6 +7,20 @@ A template for C and CPP programming that makes use of the cmocka unit testing f
 | 
			
		|||
 | 
			
		||||
## Resources
 | 
			
		||||
 | 
			
		||||
## Documentation
 | 
			
		||||
 | 
			
		||||
Documentation genreation is handled with Doxygen.
 | 
			
		||||
 | 
			
		||||
**Building documentation**
 | 
			
		||||
```sh
 | 
			
		||||
doxygen ./Doxyfile
 | 
			
		||||
# Magic happens
 | 
			
		||||
ls ./docs
 | 
			
		||||
```
 | 
			
		||||
And that's it.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
## Contributions
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		
		Reference in a new issue