Documentation error in Three

The construct:
```
...of each item ?
  //!`.
  //! \param viewer the active `Viewer_interface`.
```
leads to the fact that the `todo` and the `param` are joined and shown as:
```
... of each item ? . \param viewer the activeViewer_interface`.
```

Files:
- doc_output/Three/structCGAL_1_1Three_1_1Edge__container.html
- doc_output/Three/structCGAL_1_1Three_1_1Point__container.html

(also corrected a typo)
This commit is contained in:
albert-github 2022-09-24 14:50:09 +02:00
parent a9d5e019b7
commit 431a63ed7b
2 changed files with 4 additions and 4 deletions

View File

@ -63,8 +63,8 @@ struct DEMO_FRAMEWORK_EXPORT Edge_container :public Primitive_container
//! \brief initGL creates the `Vbo`s and `Vao`s of this `Edge_container`.
//! \attention It must be called within a valid OpenGL context. The `draw()` function of an item is always a safe place to call this.
//!
//! \todo Is it a good idea to call InitGL of each item in the scene so the developper doesn't have to worry about this in each draw() of each item ?
//!`.
//! \todo Is it a good idea to call InitGL of each item in the scene so the developer doesn't have to worry about this in each draw() of each item ?
//!
//! \param viewer the active `Viewer_interface`.
//!
void initGL(Viewer_interface *viewer) Q_DECL_OVERRIDE;

View File

@ -59,8 +59,8 @@ struct DEMO_FRAMEWORK_EXPORT Point_container :public Primitive_container
//! \brief initGL creates the `Vbo`s and `Vao`s of this `Point_container`.
//! \attention It must be called within a valid OpenGL context. The `draw()` function of an item is always a safe place to call this.
//!
//! \todo Is it a good idea to call InitGL of each item in the scene so the developper doesn't have to worry about this in each draw() of each item ?
//!`.
//! \todo Is it a good idea to call InitGL of each item in the scene so the developer doesn't have to worry about this in each draw() of each item ?
//!
//! \param viewer the active `Viewer_interface`.
//!
void initGL(Viewer_interface *viewer) Q_DECL_OVERRIDE;