SDL icon indicating copy to clipboard operation
SDL copied to clipboard

Remove remaining \file tags from comments

Open Sackzement opened this issue 4 months ago • 2 comments

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

Sackzement avatar Oct 05 '24 02:10 Sackzement