doxygen @ tags replaced to \

This commit is contained in:
2022-03-14 21:19:31 +03:00
parent 9bf1a11701
commit 54b5372356
142 changed files with 1079 additions and 1079 deletions

View File

@@ -26,7 +26,7 @@
#endif
/** \class PIKbdListener
* @brief Keyboard console input listener
* \brief Keyboard console input listener
* \details This class provide listening of console keyboard input.
* There is two ways to receive pressed key:
* * external static function with format "void func(char key, void * data_)"

View File

@@ -1,5 +1,5 @@
/*! @file pikbdlistener.h
* @brief Keyboard console input listener
/*! \file pikbdlistener.h
* \brief Keyboard console input listener
*/
/*
PIP - Platform Independent Primitives
@@ -181,20 +181,20 @@ public:
//! \{
//! \fn void enableExitCapture(int key = 'Q')
//! @brief Enable exit key "key" awaiting
//! \brief Enable exit key "key" awaiting
//! \fn void disableExitCapture()
//! @brief Disable exit key awaiting
//! \brief Disable exit key awaiting
//! \fn void setActive(bool yes = true)
//! @brief Set keyboard listening is active or not
//! \brief Set keyboard listening is active or not
//! \}
//! \events
//! \{
//! \fn void keyPressed(PIKbdListener::KeyEvent key, void * data)
//! @brief Raise on key "key" pressed, "data" is custom data
//! \brief Raise on key "key" pressed, "data" is custom data
//! \}

View File

@@ -1,5 +1,5 @@
/*! @file piscreen.h
* @brief Console GUI class
/*! \file piscreen.h
* \brief Console GUI class
*/
/*
PIP - Platform Independent Primitives
@@ -80,23 +80,23 @@ public:
//! \{
//! \fn void waitForFinish()
//! @brief block until finished (exit key will be pressed)
//! \brief block until finished (exit key will be pressed)
//! \fn void start(bool wait = false)
//! @brief Start console output and if "wait" block until finished (exit key will be pressed)
//! \brief Start console output and if "wait" block until finished (exit key will be pressed)
//! \fn void stop(bool clear = false)
//! @brief Stop console output and if "clear" clear the screen
//! \brief Stop console output and if "clear" clear the screen
//! \}
//! \events
//! \{
//! \fn void keyPressed(PIKbdListener::KeyEvent key, void * data)
//! @brief Raise on key "key" pressed, "data" is pointer to %PIConsole object
//! \brief Raise on key "key" pressed, "data" is pointer to %PIConsole object
//! \fn void tileEvent(PIScreenTile * tile, PIScreenTypes::TileEvent e)
//! @brief Raise on some event "e" from tile "tile"
//! \brief Raise on some event "e" from tile "tile"
//! \}

View File

@@ -1,5 +1,5 @@
/*! @file piscreenconsole.h
* @brief Tile for PIScreen with PIConsole API
/*! \file piscreenconsole.h
* \brief Tile for PIScreen with PIConsole API
*
* This file declares TileVars
*/

View File

@@ -1,5 +1,5 @@
/*! @file piscreendrawer.h
* @brief Drawer for PIScreen
/*! \file piscreendrawer.h
* \brief Drawer for PIScreen
*/
/*
PIP - Platform Independent Primitives

View File

@@ -1,5 +1,5 @@
/*! @file piscreentile.h
* @brief Basic PIScreen tile
/*! \file piscreentile.h
* \brief Basic PIScreen tile
*/
/*
PIP - Platform Independent Primitives

View File

@@ -1,5 +1,5 @@
/*! @file piscreentiles.h
* @brief Various tiles for PIScreen
/*! \file piscreentiles.h
* \brief Various tiles for PIScreen
*/
/*
PIP - Platform Independent Primitives

View File

@@ -1,5 +1,5 @@
/*! @file piscreentypes.h
* @brief Types for PIScreen
/*! \file piscreentypes.h
* \brief Types for PIScreen
*/
/*
PIP - Platform Independent Primitives

View File

@@ -1,5 +1,5 @@
/*! @file piterminal.h
* @brief Virtual terminal
/*! \file piterminal.h
* \brief Virtual terminal
*/
/*
PIP - Platform Independent Primitives