Doxygen equations1/13/2024 ![]() Doxygen only generates documentation from.The doxygen manual also provides information about the available commands and usage: Rendering equations with Doxygen and MathJax in CHM file.Sphinx offers better formatting and customization options, but Doxygen has stronger support for C++ and can parse code comments more accurately in certain cases. If you update the doxygen comments for a class, rebuild the "doxygen" target to check that there are no errors and your documentation appears as expected. Short answer: Doxygen vs Sphinx Doxygen is a documentation generator that supports multiple programming languages, while Sphinx primarily targets Python.The best way to get oriented to doxygen is to review some examples.The doxygen comments that appear in the html file for each class are generated from a classes header file.If you would like to allow line breaks within inline math formulas at certain symbols, such as commas for example, heres a solution: Allowing line break at, in inline math mode. You could insert allowbreak at places were it should be allowed as well. You can also search Doxygen using the box in the top right. LaTeX can break lines within inline formulas, however it does it only at certain places. Explore the Class List and Class Hierarchy using the navigation pane on the left.A set of html files will be built in the folder "html" in your OpenSim build directory. Navigate to this folder and double click on "index.html" to view the main landing page. There are only some syntaxes that can be parsed by VSCode.Doxygen documentation is generated by right clicking on the doxygen project in your compiler (Visual Studio) and selecting "Build".More.Generate and Explore the Doxygen Documentation Kconv_common ( matrix &kc, matrix &Ja, matrix &Jb, symbolic &S, sym &a_, sym &b_) constĬheck_jacobian ( solver *op, const char *eqn) Spectrum ( figure *, const matrix &, int parity=0) constĪdd_kconv ( solver *op, const char *eqn, const matrix &d)Īdd_dkconv_dz ( solver *op, const char *eqn, const matrix &d) Remap (int ndomains, int *npts, int nth, int nex)įind_boundaries (const matrix &logTi) constĭistribute_domains (int ndom, matrix &zif, bool check_only=false) constĭistribute_domains (int ndomains, int &conv_new, double p_cc=0) constĭraw ( figure *, const matrix &, int parity=0) constĭrawi ( figure *, const matrix &, int sr, int st, int parity=0) constĭrawc ( figure *, const matrix &, int ncontours, int parity=0) constĭrawci ( figure *, const matrix &, int sr, int st, int ncontours, int parity=0) const Initialize star's chemical composition, equation of state, opacity, nuclear reaction, mass definition, pi_c, Lambda, velocity, units, atmosphere, flatness, scaled keplerian angular velocity. Insert the definitions depending on opacity and eos tables into the solver, and the definitions used by the mapping (eta,deta,Ri,dRi.), and the entropy More.Įquation setting the 'simple' atmosphere model equations To be checked. More.Įquation setting the surface effective temperature Derived from sigma T_e^4 = -xi. More.Įquation giving the effective surface gravity gsup gsup=(- P)/rho. doxygen 1.8.17 OPENFOAM is a registered trademark of. More.Įquation setting the equatorial angular velocity. : The treatment of each term in the system of equations is specified in the fvSchemes dictionary. Option also to define the stellar surface as a tau=cst or P=cst. For a line by line description of a source files use the \dontinclude command in combination with the \line, \skip, \skipline, and \until commands. Part of the Jacobian associated with the mapping There are geometrical relations and physical relations placing the physical interfaces on surfaces zeta=cst. The main purpose of the \include command is to avoid code duplication in case of example blocks that consist of multiple source and header files. Writes the equations for the dimensional quantities (T_c, rho_c, R, etc.) More. Writes temperature and luminosity equations and interface conditions into the solver. equation discreized with the implicit Euler involves the solution of a system of equations. Writes movement and vorticity equations into the solver. Build doxygen documentation Bibliography Namespaces Namespace. Writes Poisson equation and interface conditions into the solver. ![]() Performs one step of the Newton algorithm to compute the star's internal structure. Write (const char *output_file, char output_mode='b') const Init (const char *input_file, const char *param_file, int argc, char *argv)Ĭheck_arg (char *arg, char *val, int *change_grid)
0 Comments
Leave a Reply.AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |