Commit 0d38c343 authored by Sebastien Timmermans's avatar Sebastien Timmermans 🎹
Browse files

[Ci-skip][Contribute files] change prefix //! for VS compatibility in README.md

parent 0d3d3823
......@@ -57,7 +57,7 @@ All the following should be banned:
* __Files end__ by one newline.
## Documentation
The documentation is provided onlne and synchronized with the _dev_ branch: [MbsysC Doc](http://robotran.git-page.immc.ucl.ac.be/mbsysc/).
The documentation is provided online and synchronized with the _dev_ branch: [MbsysC Doc](http://robotran.git-page.immc.ucl.ac.be/mbsysc/).
General rules:
* All function should be documented (purpose, arguments, return values)
* The documentation is written in the header files.
......@@ -91,22 +91,22 @@ Another example, for a structure:
*/
struct MbsData
{
int npt; ///< Number of anchor points.
double *dpt[3+1]; ///< Array containing the coordinate of all anchor points.
int *qlocked; ///< Array with the indices of locked articulations.
///< Those articulations have a constant position defined by the user \f$ q(nqc)=cte \f$.
double **SWr;///< Array of Swr vector for each external forces.
///< Swr(9,1) = [Fx; Fy; Fz; Mx; My; Mz; dxF]:
///< - Force components (expressed in the inertial frame) : Fx, Fy, Fz
///< - Pure torque components (expressed in the inertial frame) : Mx, My, Mz
///< - Application point local coordinates vector (expressed in the body-fixed frame): dxF(1:3,1)
///<
///< WARNING: Indexes convention is the opposite of what is usually done in MBsysC.
int npt; //! Number of anchor points.
double *dpt[3+1]; //! Array containing the coordinate of all anchor points.
int *qlocked; //! Array with the indices of locked articulations.
//! Those articulations have a constant position defined by the user \f$ q(nqc)=cte \f$.
double **SWr;//! Array of Swr vector for each external forces.
//! Swr(9,1) = [Fx; Fy; Fz; Mx; My; Mz; dxF]:
//! - Force components (expressed in the inertial frame) : Fx, Fy, Fz
//! - Pure torque components (expressed in the inertial frame) : Mx, My, Mz
//! - Application point local coordinates vector (expressed in the body-fixed frame): dxF(1:3,1)
//!
//! WARNING: Indexes convention is the opposite of what is usually done in MBsysC.
};
```
Nothing special, but note:
* LaTeX equations are supported: `\f$ q(nqc)=cte \f$` ;
* First line appear on the summary of the member, other line in the detailled part of the documentation;
* First line appear on the summary of the member, other line in the detailed part of the documentation;
* Lists are supported.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment