Doc++

doc/building.dox

@@ -499,7 +499,9 @@ can specify which parts will be built and which not:
 -   `MAGNUM_WITH_TEXTURETOOLS` --- Build the @ref TextureTools library. Enabled
     automatically if `MAGNUM_WITH_TEXT` or `MAGNUM_WITH_DISTANCEFIELDCONVERTER`
     is enabled.
--   `MAGNUM_WITH_TRADE` --- Build the @ref Trade library.
+-   `MAGNUM_WITH_TRADE` --- Build the @ref Trade library. Enabled automatically
+    if `MAGNUM_WITH_MESHTOOLS`, `MAGNUM_WITH_PRIMITIVES`
+    or `MAGNUM_WITH_SCENETOOLS` is enabled.
 -   `MAGNUM_WITH_VK` --- Build the @ref Vk library. Depends on Vulkan, not
     enabled by default.
 

doc/changelog.dox

@@ -738,7 +738,8 @@ See also:
 -   Fixed assertions related to OpenGL driver workarounds when the proprietary
     AMDGPU PRO drivers are used on Linux
 -   Fixed @relativeref{Corrade,Utility::Tweakable} parsers to compile with
-    negative @ref Math::Angle literals such as @cpp _(-15.0_degf) @ce
+    negative @ref Math::Deg / @ref Math::Rad literals such as
+    @cpp _(-15.0_degf) @ce
 -   Fixed an assertion when using @ref MeshTools::removeDuplicates() on an
     interleaved @ref Trade::MeshData that included padding at the beginning or
     end of each vertex

doc/custom-buildsystems-order.dot

@@ -89,6 +89,7 @@ digraph "Magnum library dependency order" {
     MagnumSceneGraph -> Magnum
 
     MagnumShaders -> MagnumGL
+
     MagnumShaderTools -> Magnum
     MagnumShaderTools -> CorradePluginManager
 

doc/developers.dox

@@ -67,9 +67,8 @@ required to follow them to the point.
         files (needed so QtCreator lists all project files properly)
     -   verify that debug postfix is set
         (@cmake set_target_properties(MagnumLibraryName PROPERTIES DEBUG_POSTFIX "-d") @ce)
-    -   verify that folder is set for all libraries and `OBJECT` libraries to
+    -   verify that folder is correctly set for the `CMakeLists.txt` file
-        avoid cluttering project tree view in IDEs
+        (@cmake set(CMAKE_FOLDER "Magnum/LibraryName") @ce)
-        (@cmake set_target_properties(MagnumLibraryName PROPERTIES FOLDER "Magnum/LibraryName") @ce)
     -   verify that target installation is done in proper places (separate
         `RUNTIME` / `LIBRARY` / `ARCHIVE` destinations)
     -   verify that @cmake set_target_properties(MagnumLibraryName PROPERTIES VERSION ${MAGNUM_LIBRARY_VERSION} SOVERSION ${MAGNUM_LIBRARY_SOVERSION}) @ce
@@ -82,12 +81,15 @@ required to follow them to the point.
 6.  Create a new `src/Magnum/LibraryName/Test/` directory:
     -   add a `CMakeLists.txt` with pre-populated license header, add your name
         to it
+    -   verify that folder is correctly set for the `CMakeLists.txt` file
+        (@cmake set(CMAKE_FOLDER "Magnum/LibraryName/Test") @ce)
     -   conditionally @cmake add_subdirectory() @ce it if `MAGNUM_BUILD_TESTS`
         is enabled
 7.  Create a new `src/Magnum/LibraryName/LibraryName.h` header for forward
     declarations (if needed), add a file-level doc block with
     <tt>Forward declarations for the \@ref Magnum::LibraryName namespace</tt>
     as brief docs
+    -   reference it from `doc/compilation-speedup.dox`
 8.  Create a new `src/Magnum/LibraryName/visibility.h` header with
     `MAGNUM_LIBRARYNAME_EXPORT` and `MAGNUM_LIBRARYNAME_LOCAL` macros by
     copypasting it from another library:
@@ -107,32 +109,44 @@ required to follow them to the point.
         with CMake
 10. Code and test the rest of the library, see @ref developers-file and
     @ref developers-symbol for more information
-11. Add the `MAGNUM_WITH_LIBRARYNAME` option to all files in `package/` directory,
+11. Add the `MAGNUM_WITH_LIBRARYNAME` option to all files in the `package/ci`
-    explicitly saying either `ON` or `OFF` based on platform support:
+    directory, explicitly saying either `ON` or `OFF` based on platform
+    support and whether it makes sense to enable it for given job if it's off
+    by default, or disable it for given job if it's enabled by default:
+    -   all `package/ci/appveyor-*.bat` files (`^` is a line continuation)
+    -   all `package/ci/``*.sh` files (@c \\ is a line continuation)
+12. Add the `MAGNUM_WITH_LIBRARYNAME` option to other files in `package/`
+    directory if it's off by default but it makes sense to include it in given
+    package (such as, say, @ref Audio which is off by default because it
+    relies on OpenAL, but makes sense to be included on Linux and macOS because
+    there it's easy to get OpenAL):
     -   all `package/archlinux/PKGBUILD*` files (and the AUR package(s))
+    -   all `package/msys/PKGBUILD*` files (and the AUR package(s))
     -   the `package/debian/rules` file (watch out, tabs!)
     -   the `package/gentoo/` `*.ebuild` file
     -   the `package/homebrew/` `*.rb` file (watch out, Ruby!)
-    -   all `package/ci/appveyor-*.bat` files (`^` is a line continuation)
+13. If the library is enabled by default, disable it in `package/ci/` of
-    -   all `package/ci/``*.sh` files (@c \\ is a line continuation)
+    depending projects if not needed for a particular job to save CI times
-12. If the library has dependencies:
+14. If the library has dependencies:
     -   make sure they are mentioned in the library documentation
     -   make sure they are mentioned in building and CMake docs
     -   make sure they are mentioned in `CREDITS.md`
-    -   make sure AppVeyor and Travis downloads them (based on platform
+    -   make sure AppVeyor and CircleCI downloads them (based on platform
         support)
-13. Mention the library in `doc/changelog.dox` (or similar files in other
+15. Add the library to the graph in `doc/custom-buildsystem-order.dot`, listing
+    also its depdendencies to the rest of the project
+16. Mention the library in `doc/changelog.dox` (or similar files in other
     repos)
-14. @ref building-doc "Build documentation":
+17. @ref building-doc "Build documentation":
-    -   run [doxygen.py](http://mcss.mosra.cz/doxygen/) on `Doxyfile-mcss`
+    -   run [doxygen.py](https://mcss.mosra.cz/documentation/doxygen/) on
-        and verify there are no new warnings
+        `Doxyfile-mcss` and verify there are no new warnings
     -   eyeball the namespace and directory docs, fix suspicious things, look
         also in the building and cmake docs
-15. Build a coverage build (`package/archlinux/PKGBUILD-coverage`), or abuse
+18. Build a coverage build (`package/archlinux/PKGBUILD-coverage`), or abuse
     the CI for that later
-16. Push to a temporary branch (e.g., `next`)
+19. Push to a temporary branch (e.g., `next`)
-17. Iterate until the CIs are green and the code coverage is good enough
+20. Iterate until the CIs are green and the code coverage is good enough
-18. Merge to `master`
+21. Merge to `master`
 
 In order to remove a library, be sure to touch all places mentioned above, only
 in inverse --- but usually @ref developers-deprecation "deprecate first".