Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove remaining \file tags from comments #11070

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Sackzement
Copy link
Contributor

Removed the \file tag from all files except from SDL.h.

Tried to remove it from SDL.h as well like this:

diff --git a/include/SDL3/SDL.h b/include/SDL3/SDL.h
index e9f1d6bee..1c34c5c42 100644
--- a/include/SDL3/SDL.h
+++ b/include/SDL3/SDL.h
@@ -19,11 +19,7 @@
   3. This notice may not be removed or altered from any source distribution.
 */
 
-/**
- *  \file SDL.h
- *
- *  Main include header for the SDL library, version 3.1.3
- */
+/* Main include header for the SDL library, version 3.1.3 */
 
 #ifndef SDL_h_
 #define SDL_h_

... but then the github workflows for all Ubuntu tests failed with following error:

Run set -e
  set -e
  build-scripts/test-versioning.sh
  python build-scripts/check_android_jni.py
  python build-scripts/check_stdlib_usage.py
  shell: /usr/bin/sh -e {0}
  env:
    pythonLocation: /opt/hostedtoolcache/Python/3.12.6/x64
    PKG_CONFIG_PATH: /opt/hostedtoolcache/Python/3.12.6/x64/lib/pkgconfig
    Python_ROOT_DIR: /opt/hostedtoolcache/Python/3.12.6/x64
    Python2_ROOT_DIR: /opt/hostedtoolcache/Python/3.12.6/x64
    Python3_ROOT_DIR: /opt/hostedtoolcache/Python/3.12.6/x64
    LD_LIBRARY_PATH: /opt/hostedtoolcache/Python/3.12.6/x64/lib
not ok - SDL.h  disagrees with SDL_version.h 3.1.3
ok - CMakeLists.txt 3.1.3
ok - SDLActivity.java 3.1.3
ok - version.rc FILEVERSION 3,1,3,0
ok - version.rc PRODUCTVERSION 3,1,3,0
ok - version.rc FileVersion 3, 1, 3, 0
ok - version.rc ProductVersion 3, 1, 3, 0
ok - Info-Framework.plist CFBundleShortVersionString 3.1.3
ok - Info-Framework.plist CFBundleVersion 3.1.3
ok - SDL.info Title 3.1.3
ok - project.pbxproj MARKETING_VERSION is consistent
ok - project.pbxproj DYLIB_COMPATIBILITY_VERSION is consistent
ok - project.pbxproj DYLIB_CURRENT_VERSION is consistent
1..13
Error: Process completed with exit code 1.

All other tests passed.
Only these 4 Ubuntu tests failed:

Ubuntu 20.04 (Intel Compiler)
Ubuntu 22.04
Ubuntu 20.04 (Intel oneAPI)
Ubuntu 20.04

@icculus
Copy link
Collaborator

icculus commented Oct 5, 2024

Don't merge this yet, I can't remember if we use the \file tags in lieu of full category documentation. I'll check in the morning.

@Sackzement
Copy link
Contributor Author

Sackzement commented Oct 5, 2024

From these files, the \file flag is removed:

include/SDL3/SDL_bits.h
include/SDL3/SDL_endian.h
include/SDL3/SDL_main.h

include/SDL3/SDL_test.h
include/SDL3/SDL_test_common.h
include/SDL3/SDL_test_compare.h
include/SDL3/SDL_test_font.h
include/SDL3/SDL_test_harness.h
include/SDL3/SDL_test_log.h
include/SDL3/SDL_test_md5.h
include/SDL3/SDL_test_memory.h

include/build_config/SDL_build_config.h
include/build_config/SDL_build_config.h.cmake
include/build_config/SDL_build_config_android.h
include/build_config/SDL_build_config_emscripten.h
include/build_config/SDL_build_config_minimal.h
include/build_config/SDL_revision.h.cmake

These files already have a # Category tag:

include/SDL3/SDL_bits.h
include/SDL3/SDL_endian.h
include/SDL3/SDL_main.h

The rest of the files:
tests, build_configs and the cmake-revision file
... don't have a # Category tag, and I think they aren't supposed to.

Btw:
It would be nice if SDL.h was also listed on the category page.
It isn't a category per se, but it's still the central header.

@slouken slouken added this to the 3.2.0 milestone Oct 8, 2024
@icculus icculus self-assigned this Dec 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants