JustEnoughMod
Toggle main menu visibility
Main Page
Related Pages
Topics
Namespaces
Namespace List
Namespace Members
All
Functions
Classes
Class List
Class Index
Class Hierarchy
Class Members
All
_
a
b
c
d
e
f
h
i
j
m
o
p
q
s
t
u
v
x
y
~
Functions
_
a
d
e
f
j
m
o
p
q
s
t
u
v
~
Variables
Enumerations
Enumerator
Related Symbols
Files
File List
File Members
All
Functions
Variables
Typedefs
Enumerations
Enumerator
Macros
Examples
•
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Modules
Pages
Loading...
Searching...
No Matches
javadoc-banner.h
1
10
void
cstyle(
int
theory );
11
12
/*******************************************************************************
13
* A brief history of JavaDoc-style (C-style) banner comments.
14
*
15
* This is the typical JavaDoc-style C-style "banner" comment. It starts with
16
* a forward slash followed by some number, n, of asterisks, where n > 2. It's
17
* written this way to be more "visible" to developers who are reading the
18
* source code.
19
*
20
* Often, developers are unaware that this is not (by default) a valid Doxygen
21
* comment block!
22
*
23
* However, as long as JAVADOC_BLOCK = YES is added to the Doxyfile, it will
24
* work as expected.
25
*
26
* This style of commenting behaves well with clang-format.
27
*
28
* @param theory Even if there is only one possible unified theory. it is just a
29
* set of rules and equations.
30
******************************************************************************/
31
void
javadocBanner(
int
theory );
32
33
/***************************************************************************/
45
void
doxygenBanner(
int
theory );
doxygen-1.10.0
examples
javadoc-banner.h
Generated by
1.10.0