瀏覽代碼

Documentation work

Camilla Löwy 6 年之前
父節點
當前提交
0fa77ea63a
共有 2 個文件被更改,包括 37 次插入37 次删除
  1. 35 35
      docs/news.dox
  2. 2 2
      docs/window.dox

+ 35 - 35
docs/news.dox

@@ -10,8 +10,8 @@
 These are the release notes for version 3.3.  For a more detailed view including
 all fixed bugs see the [version history](https://www.glfw.org/changelog.html).
 
-Please review the caveats and deprecations if your project was written against
-an earlier version of GLFW 3.
+Please review the caveats, deprecations and removals if your project was written
+against an earlier version of GLFW 3.
 
 
 @subsection features_33 New features in version 3.3
@@ -196,8 +196,8 @@ For more information see @ref monitor_userptr and @ref joystick_userptr.
 @subsubsection macos_nib_33 macOS menu bar from nib file
 
 GLFW will now load a `MainMenu.nib` file if found in the `Contents/Resources`
-directory of the application bundle as a way to replace the GLFW menu bar with
-a custom one.  This can be disabled with the
+directory of the application bundle, as a way to replace the GLFW menu bar
+without recompiling GLFW.  This behavior can be disabled with the
 [GLFW_COCOA_MENUBAR](@ref GLFW_COCOA_MENUBAR_hint) initialization hint.
 
 
@@ -226,7 +226,6 @@ input.
 
 @subsection caveats_33 Caveats for version 3.3
 
-
 @subsubsection joystick_layout_33 Layout of joysticks have changed
 
 The way joystick elements are arranged have changed to match SDL2 in order to
@@ -282,23 +281,6 @@ the read limit has changed.  Any string that could be written before still can
 be.
 
 
-@subsubsection macos_options_33 macOS specific compilation options removed
-
-The `GLFW_USE_RETINA`, `GLFW_USE_CHDIR` and `GLFW_USE_MENUBAR` CMake options and
-the `_GLFW_USE_RETINA`, `_GLFW_USE_CHDIR` and `_GLFW_USE_MENUBAR` compile-time
-macros have been removed.
-
-These options and macros are replaced by the window hint
-[GLFW_COCOA_RETINA_FRAMEBUFFER](@ref GLFW_COCOA_RETINA_FRAMEBUFFER_hint)
-and the init hints
-[GLFW_COCOA_CHDIR_RESOURCES](@ref GLFW_COCOA_CHDIR_RESOURCES_hint) and
-[GLFW_COCOA_MENUBAR](@ref GLFW_COCOA_MENUBAR_hint).
-
-Existing projects and makefiles that set these options or define these macros
-during compilation of GLFW will still build but it will have no effect and the
-default behaviors will be used.
-
-
 @subsubsection x11_linking_33 X11 extension libraries are loaded dynamically
 
 GLFW now loads all X11 extension libraries at initialization.  The only X11
@@ -317,16 +299,6 @@ a requirement of the GLFW CMake files.  The GLFW source files do not depend on
 CMake.
 
 
-@subsubsection lib_suffix_33 CMake option LIB_SUFFIX replaced with GNUInstallDirs
-
-GLFW now uses the GNUInstallDirs CMake package to handle platform specific
-details like the library directory suffix and the `LIB_SUFFIX` CMake option has
-been removed.
-
-Existing projects and makefiles that set the `LIB_SUFFIX` option will use the
-suffix chosen by the GNUInstallDirs package and the option will be ignored.
-
-
 @subsection deprecations_33 Deprecations in version 3.3
 
 @subsubsection charmods_callback_deprecated Character with modifiers callback
@@ -352,10 +324,38 @@ will be removed in a future release.
 
 @subsection removals_33 Removals in 3.3
 
-@subsubsection mir_removed_33 Mir support has been removed
+@subsubsection macos_options_33 macOS specific CMake options and macros
+
+The `GLFW_USE_RETINA`, `GLFW_USE_CHDIR` and `GLFW_USE_MENUBAR` CMake options and
+the `_GLFW_USE_RETINA`, `_GLFW_USE_CHDIR` and `_GLFW_USE_MENUBAR` compile-time
+macros have been removed.
+
+These options and macros are replaced by the window hint
+[GLFW_COCOA_RETINA_FRAMEBUFFER](@ref GLFW_COCOA_RETINA_FRAMEBUFFER_hint)
+and the init hints
+[GLFW_COCOA_CHDIR_RESOURCES](@ref GLFW_COCOA_CHDIR_RESOURCES_hint) and
+[GLFW_COCOA_MENUBAR](@ref GLFW_COCOA_MENUBAR_hint).
+
+Existing projects and makefiles that set these options or define these macros
+during compilation of GLFW will still build but it will have no effect and the
+default behaviors will be used.
+
+
+@subsubsection lib_suffix_33 CMake option LIB_SUFFIX
+
+The `LIB_SUFFIX` CMake option has been removed.  GLFW now uses the
+GNUInstallDirs CMake package to handle platform specific details like the
+library directory suffix and the `LIB_SUFFIX` CMake option has been removed.
+
+Existing projects and makefiles that set the `LIB_SUFFIX` option will use the
+suffix chosen by the GNUInstallDirs package and the option will be ignored.
+
+
+@subsubsection mir_removed_33 Mir support
 
-Mir support has been completely removed as the Mir project has implemented
-support for the Wayland protocol.
+The experimental Mir support has been completely removed as the Mir project has
+implemented support for the Wayland protocol and is recommending that
+applications use that instead.
 
 Existing projects and makefiles that select Mir when compiling GLFW will fail.
 Use Wayland or X11 instead.

+ 2 - 2
docs/window.dox

@@ -69,8 +69,8 @@ information about retrieving video modes, see @ref monitor_modes.
 
 Video mode field        | Corresponds to
 ----------------        | --------------
-GLFWvidmode.width       | `width` parameter
-GLFWvidmode.height      | `height` parameter
+GLFWvidmode.width       | `width` parameter of @ref glfwCreateWindow
+GLFWvidmode.height      | `height` parameter of @ref glfwCreateWindow
 GLFWvidmode.redBits     | @ref GLFW_RED_BITS hint
 GLFWvidmode.greenBits   | @ref GLFW_GREEN_BITS hint
 GLFWvidmode.blueBits    | @ref GLFW_BLUE_BITS hint