Apps
|
Functions | |
function | fill (N, c) |
a function to create a string by repeating a character | |
function | pdf (x, sigma, mu) |
calculates the probability density function | |
Variables | |
parameterNumber | mu = 0 |
mean (location of the peak | |
parameterNumber | sigma = 3 |
variance | |
The purpose of this tutorial is to demonstrate how you can document your lua code so that you get a nice html documentation with doxygen. You can get a list of commands at http://www.stack.nl/~dimitri/doxygen/commands.html You can also take a look at pageUG4DoxygenQuickref and pageUG4CodingStyle
function fill | ( | N | , |
c | |||
) |
a function to create a string by repeating a character
this is our doxygen comment in LUA this is our multi-line doxygen comment fill
This function is really useful for formatting tables.
N | number of times c is to be repeated |
c | character to repeat (if omitted, " ") |
location: /home/runner/work/docs/docs/ug4/apps/Tutorials / tut10_doxygen.lua :35-42
calculates the probability density function
x | |
mu | \(\mu\) = mean (location of the peak) default 0 |
sigma | \(\sigma^2\) = variance. default 1 |
location: /home/runner/work/docs/docs/ug4/apps/Tutorials / tut10_doxygen.lua :51-53
parameterNumber mu = 0 |
parameterNumber sigma = 3 |
variance
variance is a a measure of how far a set of numbers is spread out