Add Doxygen aliases for custom paragraphs

2024-11-22 04:54:35 +00:00 · 2016-01-31 21:32:14 +01:00 · 2016-01-31 21:32:14 +01:00 · 951a9583fa
commit 951a9583fa
parent 5499fd307a
3 changed files with 296 additions and 448 deletions
--- a/docs/Doxyfile.in
+++ b/docs/Doxyfile.in
@ -195,7 +195,14 @@ TAB_SIZE               = 8
 # will result in a user-defined paragraph with heading "Side Effects:".
 # You can put \n's in the value part of an alias to insert newlines.

-ALIASES                =
+ALIASES                = "thread_safety=@par Thread safety\n" \
+                         "pointer_lifetime=@par Pointer lifetime\n" \
+                         "analysis=@par Analysis\n" \
+                         "reentrancy=@par Reentrancy\n" \
+                         "glfw3=@par\n__GLFW 3:__" \
+                         "x11=__X11:__" \
+                         "win32=__Windows:__" \
+                         "osx=__OS X:__"

 # This tag can be used to specify a number of word-keyword mappings (TCL only).
 # A mapping has the form "name=value". For example adding
--- a/include/GLFW/glfw3.h
+++ b/include/GLFW/glfw3.h
--- a/include/GLFW/glfw3native.h
+++ b/include/GLFW/glfw3native.h
@ -127,11 +127,10 @@ extern "C" {
 *  of the specified monitor, or `NULL` if an [error](@ref error_handling)
 *  occurred.
 *
- *  @par Thread Safety
- *  This function may be called from any thread.  Access is not synchronized.
+ *  @thread_safety This function may be called from any thread.  Access is not
+ *  synchronized.
 *
- *  @par History
- *  Added in GLFW 3.1.
+ *  @since Added in GLFW 3.1.
 *
 *  @ingroup native
 */
@ -143,11 +142,10 @@ GLFWAPI const char* glfwGetWin32Adapter(GLFWmonitor* monitor);
 *  `\\.\DISPLAY1\Monitor0`) of the specified monitor, or `NULL` if an
 *  [error](@ref error_handling) occurred.
 *
- *  @par Thread Safety
- *  This function may be called from any thread.  Access is not synchronized.
+ *  @thread_safety This function may be called from any thread.  Access is not
+ *  synchronized.
 *
- *  @par History
- *  Added in GLFW 3.1.
+ *  @since Added in GLFW 3.1.
 *
 *  @ingroup native
 */
@ -158,11 +156,10 @@ GLFWAPI const char* glfwGetWin32Monitor(GLFWmonitor* monitor);
 *  @return The `HWND` of the specified window, or `NULL` if an
 *  [error](@ref error_handling) occurred.
 *
- *  @par Thread Safety
- *  This function may be called from any thread.  Access is not synchronized.
+ *  @thread_safety This function may be called from any thread.  Access is not
+ *  synchronized.
 *
- *  @par History
- *  Added in GLFW 3.0.
+ *  @since Added in GLFW 3.0.
 *
 *  @ingroup native
 */
@ -175,11 +172,10 @@ GLFWAPI HWND glfwGetWin32Window(GLFWwindow* window);
 *  @return The `HGLRC` of the specified window, or `NULL` if an
 *  [error](@ref error_handling) occurred.
 *
- *  @par Thread Safety
- *  This function may be called from any thread.  Access is not synchronized.
+ *  @thread_safety This function may be called from any thread.  Access is not
+ *  synchronized.
 *
- *  @par History
- *  Added in GLFW 3.0.
+ *  @since Added in GLFW 3.0.
 *
 *  @ingroup native
 */
@ -192,11 +188,10 @@ GLFWAPI HGLRC glfwGetWGLContext(GLFWwindow* window);
 *  @return The `CGDirectDisplayID` of the specified monitor, or
 *  `kCGNullDirectDisplay` if an [error](@ref error_handling) occurred.
 *
- *  @par Thread Safety
- *  This function may be called from any thread.  Access is not synchronized.
+ *  @thread_safety This function may be called from any thread.  Access is not
+ *  synchronized.
 *
- *  @par History
- *  Added in GLFW 3.1.
+ *  @since Added in GLFW 3.1.
 *
 *  @ingroup native
 */
@ -207,11 +202,10 @@ GLFWAPI CGDirectDisplayID glfwGetCocoaMonitor(GLFWmonitor* monitor);
 *  @return The `NSWindow` of the specified window, or `nil` if an
 *  [error](@ref error_handling) occurred.
 *
- *  @par Thread Safety
- *  This function may be called from any thread.  Access is not synchronized.
+ *  @thread_safety This function may be called from any thread.  Access is not
+ *  synchronized.
 *
- *  @par History
- *  Added in GLFW 3.0.
+ *  @since Added in GLFW 3.0.
 *
 *  @ingroup native
 */
@ -224,11 +218,10 @@ GLFWAPI id glfwGetCocoaWindow(GLFWwindow* window);
 *  @return The `NSOpenGLContext` of the specified window, or `nil` if an
 *  [error](@ref error_handling) occurred.
 *
- *  @par Thread Safety
- *  This function may be called from any thread.  Access is not synchronized.
+ *  @thread_safety This function may be called from any thread.  Access is not
+ *  synchronized.
 *
- *  @par History
- *  Added in GLFW 3.0.
+ *  @since Added in GLFW 3.0.
 *
 *  @ingroup native
 */
@ -241,11 +234,10 @@ GLFWAPI id glfwGetNSGLContext(GLFWwindow* window);
 *  @return The `Display` used by GLFW, or `NULL` if an
 *  [error](@ref error_handling) occurred.
 *
- *  @par Thread Safety
- *  This function may be called from any thread.  Access is not synchronized.
+ *  @thread_safety This function may be called from any thread.  Access is not
+ *  synchronized.
 *
- *  @par History
- *  Added in GLFW 3.0.
+ *  @since Added in GLFW 3.0.
 *
 *  @ingroup native
 */
@ -256,11 +248,10 @@ GLFWAPI Display* glfwGetX11Display(void);
 *  @return The `RRCrtc` of the specified monitor, or `None` if an
 *  [error](@ref error_handling) occurred.
 *
- *  @par Thread Safety
- *  This function may be called from any thread.  Access is not synchronized.
+ *  @thread_safety This function may be called from any thread.  Access is not
+ *  synchronized.
 *
- *  @par History
- *  Added in GLFW 3.1.
+ *  @since Added in GLFW 3.1.
 *
 *  @ingroup native
 */
@ -271,11 +262,10 @@ GLFWAPI RRCrtc glfwGetX11Adapter(GLFWmonitor* monitor);
 *  @return The `RROutput` of the specified monitor, or `None` if an
 *  [error](@ref error_handling) occurred.
 *
- *  @par Thread Safety
- *  This function may be called from any thread.  Access is not synchronized.
+ *  @thread_safety This function may be called from any thread.  Access is not
+ *  synchronized.
 *
- *  @par History
- *  Added in GLFW 3.1.
+ *  @since Added in GLFW 3.1.
 *
 *  @ingroup native
 */
@ -286,11 +276,10 @@ GLFWAPI RROutput glfwGetX11Monitor(GLFWmonitor* monitor);
 *  @return The `Window` of the specified window, or `None` if an
 *  [error](@ref error_handling) occurred.
 *
- *  @par Thread Safety
- *  This function may be called from any thread.  Access is not synchronized.
+ *  @thread_safety This function may be called from any thread.  Access is not
+ *  synchronized.
 *
- *  @par History
- *  Added in GLFW 3.0.
+ *  @since Added in GLFW 3.0.
 *
 *  @ingroup native
 */
@ -303,11 +292,10 @@ GLFWAPI Window glfwGetX11Window(GLFWwindow* window);
 *  @return The `GLXContext` of the specified window, or `NULL` if an
 *  [error](@ref error_handling) occurred.
 *
- *  @par Thread Safety
- *  This function may be called from any thread.  Access is not synchronized.
+ *  @thread_safety This function may be called from any thread.  Access is not
+ *  synchronized.
 *
- *  @par History
- *  Added in GLFW 3.0.
+ *  @since Added in GLFW 3.0.
 *
 *  @ingroup native
 */
@ -318,11 +306,10 @@ GLFWAPI GLXContext glfwGetGLXContext(GLFWwindow* window);
 *  @return The `GLXWindow` of the specified window, or `None` if an
 *  [error](@ref error_handling) occurred.
 *
- *  @par Thread Safety
- *  This function may be called from any thread.  Access is not synchronized.
+ *  @thread_safety This function may be called from any thread.  Access is not
+ *  synchronized.
 *
- *  @par History
- *  Added in GLFW 3.2.
+ *  @since Added in GLFW 3.2.
 *
 *  @ingroup native
 */
@ -335,11 +322,10 @@ GLFWAPI GLXWindow glfwGetGLXWindow(GLFWwindow* window);
 *  @return The `struct wl_display*` used by GLFW, or `NULL` if an
 *  [error](@ref error_handling) occurred.
 *
- *  @par Thread Safety
- *  This function may be called from any thread.  Access is not synchronized.
+ *  @thread_safety This function may be called from any thread.  Access is not
+ *  synchronized.
 *
- *  @par History
- *  Added in GLFW 3.2.
+ *  @since Added in GLFW 3.2.
 *
 *  @ingroup native
 */
@ -350,11 +336,10 @@ GLFWAPI struct wl_display* glfwGetWaylandDisplay(void);
 *  @return The `struct wl_output*` of the specified monitor, or `NULL` if an
 *  [error](@ref error_handling) occurred.
 *
- *  @par Thread Safety
- *  This function may be called from any thread.  Access is not synchronized.
+ *  @thread_safety This function may be called from any thread.  Access is not
+ *  synchronized.
 *
- *  @par History
- *  Added in GLFW 3.2.
+ *  @since Added in GLFW 3.2.
 *
 *  @ingroup native
 */
@ -365,11 +350,10 @@ GLFWAPI struct wl_output* glfwGetWaylandMonitor(GLFWmonitor* monitor);
 *  @return The main `struct wl_surface*` of the specified window, or `NULL` if
 *  an [error](@ref error_handling) occurred.
 *
- *  @par Thread Safety
- *  This function may be called from any thread.  Access is not synchronized.
+ *  @thread_safety This function may be called from any thread.  Access is not
+ *  synchronized.
 *
- *  @par History
- *  Added in GLFW 3.2.
+ *  @since Added in GLFW 3.2.
 *
 *  @ingroup native
 */
@ -382,11 +366,10 @@ GLFWAPI struct wl_surface* glfwGetWaylandWindow(GLFWwindow* window);
 *  @return The `MirConnection*` used by GLFW, or `NULL` if an
 *  [error](@ref error_handling) occurred.
 *
- *  @par Thread Safety
- *  This function may be called from any thread.  Access is not synchronized.
+ *  @thread_safety This function may be called from any thread.  Access is not
+ *  synchronized.
 *
- *  @par History
- *  Added in GLFW 3.2.
+ *  @since Added in GLFW 3.2.
 *
 *  @ingroup native
 */
@ -397,11 +380,10 @@ GLFWAPI MirConnection* glfwGetMirDisplay(void);
 *  @return The Mir output ID of the specified monitor, or zero if an
 *  [error](@ref error_handling) occurred.
 *
- *  @par Thread Safety
- *  This function may be called from any thread.  Access is not synchronized.
+ *  @thread_safety This function may be called from any thread.  Access is not
+ *  synchronized.
 *
- *  @par History
- *  Added in GLFW 3.2.
+ *  @since Added in GLFW 3.2.
 *
 *  @ingroup native
 */
@ -412,11 +394,10 @@ GLFWAPI int glfwGetMirMonitor(GLFWmonitor* monitor);
 *  @return The `MirSurface*` of the specified window, or `NULL` if an
 *  [error](@ref error_handling) occurred.
 *
- *  @par Thread Safety
- *  This function may be called from any thread.  Access is not synchronized.
+ *  @thread_safety This function may be called from any thread.  Access is not
+ *  synchronized.
 *
- *  @par History
- *  Added in GLFW 3.2.
+ *  @since Added in GLFW 3.2.
 *
 *  @ingroup native
 */
@ -429,11 +410,10 @@ GLFWAPI MirSurface* glfwGetMirWindow(GLFWwindow* window);
 *  @return The `EGLDisplay` used by GLFW, or `EGL_NO_DISPLAY` if an
 *  [error](@ref error_handling) occurred.
 *
- *  @par Thread Safety
- *  This function may be called from any thread.  Access is not synchronized.
+ *  @thread_safety This function may be called from any thread.  Access is not
+ *  synchronized.
 *
- *  @par History
- *  Added in GLFW 3.0.
+ *  @since Added in GLFW 3.0.
 *
 *  @ingroup native
 */
@ -444,11 +424,10 @@ GLFWAPI EGLDisplay glfwGetEGLDisplay(void);
 *  @return The `EGLContext` of the specified window, or `EGL_NO_CONTEXT` if an
 *  [error](@ref error_handling) occurred.
 *
- *  @par Thread Safety
- *  This function may be called from any thread.  Access is not synchronized.
+ *  @thread_safety This function may be called from any thread.  Access is not
+ *  synchronized.
 *
- *  @par History
- *  Added in GLFW 3.0.
+ *  @since Added in GLFW 3.0.
 *
 *  @ingroup native
 */
@ -459,11 +438,10 @@ GLFWAPI EGLContext glfwGetEGLContext(GLFWwindow* window);
 *  @return The `EGLSurface` of the specified window, or `EGL_NO_SURFACE` if an
 *  [error](@ref error_handling) occurred.
 *
- *  @par Thread Safety
- *  This function may be called from any thread.  Access is not synchronized.
+ *  @thread_safety This function may be called from any thread.  Access is not
+ *  synchronized.
 *
- *  @par History
- *  Added in GLFW 3.0.
+ *  @since Added in GLFW 3.0.
 *
 *  @ingroup native
 */