rubenwardy
/
TGUI
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated documentation

0.8
Bruno Van de Velde 2015-08-07 15:19:17 +02:00
parent 4524402ed4
commit c647322836
4 changed files with 15 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/doxyfile.in
View File

@ -655,7 +655,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
INPUT = "@DOXYGEN_INPUT_DIR@/include/TGUI" "@DOXYGEN_INPUT_DIR@/include/TGUI/extra" "@DOXYGEN_INPUT_DIR@/doc/mainpage.hpp"
INPUT = "@DOXYGEN_INPUT_DIR@/include/TGUI" "@DOXYGEN_INPUT_DIR@/include/TGUI/Loading" "@DOXYGEN_INPUT_DIR@/include/TGUI/Widgets" "@DOXYGEN_INPUT_DIR@/doc/mainpage.hpp"
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@ -709,7 +709,7 @@ EXCLUDE_PATTERNS =
# wildcard * is used, a substring. Examples: ANamespace, AClass,
# AClass::ANamespace, ANamespace::*Test
EXCLUDE_SYMBOLS = tgui::EventManager tgui::InfoFileParser tgui::CallbackFunction
EXCLUDE_SYMBOLS = EventManager InfoFileParser CallbackFunction extractTypes isConvertible TypeSet TextureData TextureDataHolder GuiContainer LayoutImpl DataIO
# The EXAMPLE_PATH tag can be used to specify one or more files or
# directories that contain example code fragments that are included (see

7
doc/mainpage.hpp
View File

@ -2,10 +2,11 @@
/// \mainpage TGUI Documentation
///
/// These pages contain the description of all usable functions and members in TGUI v0.7-dev.\n
/// The few functions that you should not use are hidden.
///
/// Make sure to also check the tutorials (http://tgui.eu/tutorials/v07/) and example codes (http://tgui.eu/example-code/v07/).
/// Make sure to also check the tutorials (https://tgui.eu/tutorials/v07/) and example codes (https://tgui.eu/example-code/v07/).
///
/// More information about this project can be found on the TGUI home page (http://tgui.eu).
/// More information about this project can be found on the TGUI home page (https://tgui.eu).
///
/// Do not hesitate to ask me questions on the forum (https://forum.tgui.eu) or by mail (texus@tgui.eu).
///
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

14
include/TGUI/Loading/ObjectConverter.hpp
View File

@ -114,7 +114,7 @@ namespace tgui
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/// @param Retrieve the saved font
/// @brief Retrieve the saved font
///
/// @return The saved font
///
@ -125,7 +125,7 @@ namespace tgui
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/// @param Retrieve the saved color
/// @brief Retrieve the saved color
///
/// @return The saved color
///
@ -136,7 +136,7 @@ namespace tgui
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/// @param Retrieve the saved borders
/// @brief Retrieve the saved borders
///
/// @return The saved borders
///
@ -147,7 +147,7 @@ namespace tgui
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/// @param Retrieve the saved string
/// @brief Retrieve the saved string
///
/// @return The saved string
///
@ -158,7 +158,7 @@ namespace tgui
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/// @param Retrieve the saved number
/// @brief Retrieve the saved number
///
/// @return The saved number
///
@ -169,7 +169,7 @@ namespace tgui
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/// @param Retrieve the saved texture
/// @brief Retrieve the saved texture
///
/// @return The saved texture
///
@ -180,7 +180,7 @@ namespace tgui
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/// @param Retrieve the type of the object that has been stored
/// @brief Retrieve the type of the object that has been stored
///
/// @return The stored object type
///

4
include/TGUI/Loading/Theme.hpp
View File

@ -82,8 +82,8 @@ namespace tgui
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/// @brief Changes the construct function of a specific widget type
///
/// @param type Type of the widget which will cause this construct function to be used
/// @param loader New function to be called when this type of widget is being loaded
/// @param type Type of the widget which will cause this construct function to be used
/// @param constructor New function to be called when this type of widget is being loaded
///
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
static void setConstructFunction(const std::string& type, const std::function<Widget::Ptr()>& constructor);