AVRly - AVR Development Resources
filename.h
Go to the documentation of this file.
1/******************************************************************************
2 @copyright Copyright © 2022 by Your Name Here.
3
4 Permission is hereby granted, free of charge, to any person obtaining a copy
5 of this software and associated documentation files (the "Software"), to deal
6 in the Software without restriction, including without limitation the rights
7 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 copies of the Software, and to permit persons to whom the Software is
9 furnished to do so, subject to the following conditions:
10
11 The above copyright notice and this permission notice shall be included in all
12 copies or substantial portions of the Software.
13
14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 SOFTWARE.
21******************************************************************************/
22
23/**
24 * @file filename.h
25 * @ingroup anatomy
26 * @author Your Name Here.
27 * @date 15th March 2022
28 * @brief The brief description goes here, keep it relatively short and to the
29 * point.
30 * @details After the brief comes the detailed description. Add an explanation
31 * of the purpose and limitations of the module, along with any other notes
32 * that may be useful to others using it.
33 * @bug Known bugs are declared and described here.
34 * @see "See also" links go here https://www.doxygen.nl/manual/docblocks.html
35 */
36
37
38// Include guards are used to ensure each header is only included once.
39#ifndef FILENAME_DOT_H
40#define FILENAME_DOT_H
41
42// Header file needed for fixed width integer types.
43#include <stdint.h>
44
45/**
46 * This is a Javadoc autobrief style comment. After the first full stop the text
47 * becomes a detailed description. Explain how to use the function here.
48 * Initialisation function names should start with 'init' and appear first.
49 * @param List the parameters here.
50 * @return Declare the return type here (not needed for void return type).
51 */
52void init_object(uint16_t value);
53
54
55/**
56 * Other public function declarations come afterwards.
57 * @return Returns a 16 bit unsigned integer. Returns are documented like this.
58 */
59uint16_t get_value(void);
60
61
62// End of include guard.
63#endif // FILENAME_DOT_H
64
65
66/*** end of file ***/
get_value
uint16_t get_value(void)
Other public function declarations come afterwards.
Definition: filename.c:87
init_object
void init_object(uint16_t value)
This is a Javadoc autobrief style comment.
Definition: filename.c:74