mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
ENH: Doxygen updates
This commit is contained in:
@ -175,7 +175,7 @@ s/.*\*\//\*\//
|
|||||||
|
|
||||||
|
|
||||||
# convert /heading in source files to bold font and add some space
|
# convert /heading in source files to bold font and add some space
|
||||||
s#\\heading \(.*\)#<br><b>\1</b>#g
|
s#\\heading \(.*\)#<br><b>\1</b><br>#g
|
||||||
|
|
||||||
# add a linebreak
|
# add a linebreak
|
||||||
s#\\linebreak#<br>#g
|
s#\\linebreak#<br>#g
|
||||||
|
|||||||
@ -769,6 +769,10 @@ INPUT = $(WM_PROJECT_DIR)/src \
|
|||||||
$(WM_PROJECT_DIR)/applications/utilities \
|
$(WM_PROJECT_DIR)/applications/utilities \
|
||||||
$(WM_PROJECT_DIR)/applications/solvers
|
$(WM_PROJECT_DIR)/applications/solvers
|
||||||
|
|
||||||
|
#For testing only
|
||||||
|
#INPUT = $(WM_PROJECT_DIR)/src/OpenFOAM/global \
|
||||||
|
# $(WM_PROJECT_DIR)/applications/solvers/incompressible
|
||||||
|
|
||||||
# This tag can be used to specify the character encoding of the source files
|
# 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
|
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
|
||||||
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
|
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
|
||||||
@ -1172,7 +1176,7 @@ HTML_DYNAMIC_SECTIONS = NO
|
|||||||
# Minimum value: 0, maximum value: 9999, default value: 100.
|
# Minimum value: 0, maximum value: 9999, default value: 100.
|
||||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||||
|
|
||||||
HTML_INDEX_NUM_ENTRIES = 100
|
HTML_INDEX_NUM_ENTRIES = 2
|
||||||
|
|
||||||
# If the GENERATE_DOCSET tag is set to YES, additional index files will be
|
# If the GENERATE_DOCSET tag is set to YES, additional index files will be
|
||||||
# generated that can be used as input for Apple's Xcode 3 integrated development
|
# generated that can be used as input for Apple's Xcode 3 integrated development
|
||||||
@ -1421,7 +1425,7 @@ EXT_LINKS_IN_WINDOW = NO
|
|||||||
# Minimum value: 8, maximum value: 50, default value: 10.
|
# Minimum value: 8, maximum value: 50, default value: 10.
|
||||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||||
|
|
||||||
FORMULA_FONTSIZE = 10
|
FORMULA_FONTSIZE = 12
|
||||||
|
|
||||||
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
|
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
|
||||||
# generated for formulas are transparent PNGs. Transparent PNGs are not
|
# generated for formulas are transparent PNGs. Transparent PNGs are not
|
||||||
|
|||||||
@ -2,7 +2,7 @@
|
|||||||
</div> <!-- main -->
|
</div> <!-- main -->
|
||||||
<div class="footer">
|
<div class="footer">
|
||||||
<p>
|
<p>
|
||||||
Copyright © 2011-2013
|
Copyright © 2011-2016
|
||||||
<a href="http://www.openfoam.com/about">OpenFOAM</a>
|
<a href="http://www.openfoam.com/about">OpenFOAM</a>
|
||||||
|
|
|
|
||||||
OPENFOAM® is a registered
|
OPENFOAM® is a registered
|
||||||
|
|||||||
@ -71,7 +71,7 @@ p:after {
|
|||||||
border:3px solid rgb(175,175,175);
|
border:3px solid rgb(175,175,175);
|
||||||
border-bottom-width: 0;
|
border-bottom-width: 0;
|
||||||
margin-top:10px;
|
margin-top:10px;
|
||||||
background:#e1f0e1;
|
background:#d5e1f0;
|
||||||
overflow:visible !important /*Firefox*/;
|
overflow:visible !important /*Firefox*/;
|
||||||
overflow:hidden /*IE6*/;
|
overflow:hidden /*IE6*/;
|
||||||
}
|
}
|
||||||
@ -265,12 +265,12 @@ p:after {
|
|||||||
}
|
}
|
||||||
|
|
||||||
div.contents a {
|
div.contents a {
|
||||||
color:rgb(85,144,112);
|
color:rgb(70,122,167);
|
||||||
font-weight:bold;
|
font-weight:bold;
|
||||||
text-decoration:none;
|
text-decoration:none;
|
||||||
}
|
}
|
||||||
div.contents a:hover {
|
div.contents a:hover {
|
||||||
color:rgb(56,94,73);
|
color:rgb(42,90,138);
|
||||||
text-decoration:underline;
|
text-decoration:underline;
|
||||||
}
|
}
|
||||||
/*
|
/*
|
||||||
@ -342,3 +342,4 @@ div.crosslinks {
|
|||||||
}
|
}
|
||||||
|
|
||||||
} /* end media print */
|
} /* end media print */
|
||||||
|
|
||||||
|
|||||||
@ -271,7 +271,7 @@ nav3-bullet
|
|||||||
padding:0 0 0 10px;
|
padding:0 0 0 10px;
|
||||||
background:url(img/bg_bullet_full_1.gif) no-repeat 0px 50%;
|
background:url(img/bg_bullet_full_1.gif) no-repeat 0px 50%;
|
||||||
text-decoration:none;
|
text-decoration:none;
|
||||||
color:rgb(56,94,73);
|
color:rgb(70,122,167);
|
||||||
font-weight:bold;
|
font-weight:bold;
|
||||||
font-size:120%;
|
font-size:120%;
|
||||||
}
|
}
|
||||||
@ -282,7 +282,7 @@ nav3-bullet
|
|||||||
padding:0 0 0 10px;
|
padding:0 0 0 10px;
|
||||||
background:url(img/bg_bullet_half_1.gif) no-repeat 0px 50%;
|
background:url(img/bg_bullet_half_1.gif) no-repeat 0px 50%;
|
||||||
text-decoration:none;
|
text-decoration:none;
|
||||||
color:rgb(56,94,73);
|
color:rgb(70,122,167);
|
||||||
font-weight:normal;
|
font-weight:normal;
|
||||||
font-size:120%;
|
font-size:120%;
|
||||||
}
|
}
|
||||||
@ -570,3 +570,4 @@ div.navpath, div.summary
|
|||||||
{
|
{
|
||||||
background-color:#d5e1f0 !important;
|
background-color:#d5e1f0 !important;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@ -86,15 +86,34 @@ tr.memlist
|
|||||||
}
|
}
|
||||||
|
|
||||||
.OFTable th {
|
.OFTable th {
|
||||||
|
height:20px;
|
||||||
text-align: left;
|
text-align: left;
|
||||||
padding: 5px;
|
padding: 5px;
|
||||||
border-bottom: 2px solid rgb(175,175,175);
|
border-bottom: 2px solid rgb(175,175,175);
|
||||||
}
|
}
|
||||||
|
|
||||||
.OFTable td {
|
.OFTable tr td {
|
||||||
|
height:20px;
|
||||||
padding-left: 5px;
|
padding-left: 5px;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.OFPlainTable {
|
||||||
|
border: 0px;
|
||||||
|
margin-top: 10px;
|
||||||
|
margin-bottom: 10px;
|
||||||
|
/* background-color: #F0F0F0; */
|
||||||
|
/* padding: 3px 7px 2px; */
|
||||||
|
}
|
||||||
|
|
||||||
|
.OFPlainTable th {
|
||||||
|
height: 20px;
|
||||||
|
text-align: left;
|
||||||
|
/* padding: 5px; */
|
||||||
|
}
|
||||||
|
|
||||||
|
.OFPlainTable tr td {
|
||||||
|
height: 20px;
|
||||||
|
padding-left: 5px;
|
||||||
div.line,
|
div.line,
|
||||||
span.comment,
|
span.comment,
|
||||||
span.keyword,
|
span.keyword,
|
||||||
|
|||||||
@ -86,13 +86,13 @@ div.navtab {
|
|||||||
/* @group Link Styling */
|
/* @group Link Styling */
|
||||||
|
|
||||||
a {
|
a {
|
||||||
color: rgb(85,144,112);
|
color: #153788;
|
||||||
font-weight: normal;
|
font-weight: normal;
|
||||||
text-decoration: none;
|
text-decoration: none;
|
||||||
}
|
}
|
||||||
|
|
||||||
.contents a:visited {
|
.contents a:visited {
|
||||||
color: rgb(85,144,112);
|
color: #1b77c5;
|
||||||
}
|
}
|
||||||
|
|
||||||
a:hover {
|
a:hover {
|
||||||
@ -546,7 +546,7 @@ table.doxtable {
|
|||||||
}
|
}
|
||||||
|
|
||||||
table.doxtable td, table.doxtable th {
|
table.doxtable td, table.doxtable th {
|
||||||
border: 1px solid rgb(85,144,112);
|
border: 1px solid #153788;
|
||||||
padding: 3px 7px 2px;
|
padding: 3px 7px 2px;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Binary file not shown.
|
Before Width: | Height: | Size: 6.0 KiB After Width: | Height: | Size: 5.5 KiB |
@ -33,12 +33,12 @@ License
|
|||||||
and academic organisations. OpenFOAM has an extensive range of features to
|
and academic organisations. OpenFOAM has an extensive range of features to
|
||||||
solve anything from complex fluid flows involving chemical reactions,
|
solve anything from complex fluid flows involving chemical reactions,
|
||||||
turbulence and heat transfer, to solid dynamics and electromagnetics.
|
turbulence and heat transfer, to solid dynamics and electromagnetics.
|
||||||
<a href="http://www.openfoam.com/features">More ...</a>
|
<a href="http://www.openfoam.com/documentation">More ...</a>
|
||||||
|
|
||||||
|
|
||||||
\section layout Code Layout
|
\section layout Code Layout
|
||||||
|
|
||||||
The OpenFOAM source code comprises of four main components:
|
The OpenFOAM source code has four main components:
|
||||||
- src:
|
- src:
|
||||||
the core OpenFOAM source code
|
the core OpenFOAM source code
|
||||||
|
|
||||||
@ -56,8 +56,9 @@ License
|
|||||||
|
|
||||||
\section usingTheCode Using the code
|
\section usingTheCode Using the code
|
||||||
|
|
||||||
- \subpage pagePostProcessing
|
- \subpage pageSolvers
|
||||||
- \subpage pageBoundaryConditions
|
- \subpage pageBoundaryConditions
|
||||||
|
- \subpage pagePostProcessing
|
||||||
|
|
||||||
|
|
||||||
\*---------------------------------------------------------------------------*/
|
\*---------------------------------------------------------------------------*/
|
||||||
|
|||||||
@ -23,7 +23,7 @@ License
|
|||||||
|
|
||||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||||
|
|
||||||
\defgroup grpDESTurbulence DES
|
\defgroup grpDESTurbulence DES turbulence
|
||||||
@{
|
@{
|
||||||
\ingroup grpTurbulence
|
\ingroup grpTurbulence
|
||||||
This group contains DES turbulence models.
|
This group contains DES turbulence models.
|
||||||
|
|||||||
@ -29,11 +29,4 @@ License
|
|||||||
This group contains RAS turbulence model boundary conditions
|
This group contains RAS turbulence model boundary conditions
|
||||||
@}
|
@}
|
||||||
|
|
||||||
\defgroup grpWallFunctions RAS wall functions
|
|
||||||
@{
|
|
||||||
\ingroup grpRASBoundaryConditions
|
|
||||||
This group contains RAS turbulence model wall functions
|
|
||||||
@}
|
|
||||||
|
|
||||||
|
|
||||||
\*---------------------------------------------------------------------------*/
|
\*---------------------------------------------------------------------------*/
|
||||||
|
|||||||
@ -23,13 +23,13 @@ License
|
|||||||
|
|
||||||
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
||||||
|
|
||||||
\defgroup grpTurbulenceBoundaryConditions turbulence boundary conditions
|
\defgroup grpTurbulenceBoundaryConditions Turbulence boundary conditions
|
||||||
@{
|
@{
|
||||||
\ingroup grpTurbulence
|
\ingroup grpTurbulence
|
||||||
This group contains turbulence model boundary conditions
|
This group contains turbulence model boundary conditions
|
||||||
@}
|
@}
|
||||||
|
|
||||||
\defgroup grpWallFunctions wall functions
|
\defgroup grpWallFunctions Wall functions
|
||||||
@{
|
@{
|
||||||
\ingroup grpTurbulenceBoundaryConditions
|
\ingroup grpTurbulenceBoundaryConditions
|
||||||
This group contains turbulence model wall functions
|
This group contains turbulence model wall functions
|
||||||
|
|||||||
Reference in New Issue
Block a user