You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/YUP Module Format.md
+12-6Lines changed: 12 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,13 +45,13 @@ The names of these source files must begin with the name of the module, but they
45
45
46
46
In order to specify that a source file should only be compiled for a specific platform, then the filename can be suffixed with one of the following (case insensitive) strings:
47
47
48
-
_apple <- compiled for Apple platforms only
49
-
_mac or _osx <- compiled for macOS only
48
+
_apple <- compiled for Apple platforms
49
+
_mac <- compiled for macOS only
50
50
_ios <- compiled for iOS only
51
51
_msft <- compiled for Microsoft platforms only
52
-
_win32 <- compiled for Windows Win32 Desktop only
53
52
_uwp <- compiled for Universal Windows Platform only
54
-
_windows <- compiled for Windows platforms only
53
+
_windows <- compiled for Windows desktop only (MSVC)
54
+
_mingw <- compiled for Windows desktop only (MinGW)
55
55
_linux <- compiled for Linux and FreeBSD only
56
56
_android <- compiled for Android only
57
57
_posix <- compiled for Posix platforms only
@@ -62,7 +62,7 @@ e.g.
62
62
yup_mymodule/yup_mymodule_1.cpp <- compiled for all platforms
63
63
yup_mymodule/yup_mymodule_2.cpp <- compiled for all platforms
64
64
yup_mymodule/yup_mymodule_mac.cpp <- compiled for macOS platforms only
65
-
yup_mymodule/yup_mymodule_win32.cpp <- compiled for Windows platforms only
65
+
yup_mymodule/yup_mymodule_windows.cpp <- compiled for Windows platforms only
66
66
67
67
Often this isn't necessary, as in most cases you can easily add checks inside the files to do different things depending on the platform, but this may be handy just to avoid clutter in user projects where files aren't needed.
68
68
@@ -130,14 +130,17 @@ Possible values:
130
130
- (Optional) A description of the type of software license that applies.
131
131
132
132
- minimumCppStandard
133
-
- (Optional) A number indicating the minimum C++ language standard that is required for this module This must be just the standard number with no prefix e.g. 20 for C++20.
133
+
- (Optional) A number indicating the minimum C++ language standard that is required for this module. This must be just the standard number with no prefix e.g. 20 for C++20.
134
134
135
135
- defines
136
136
- (Optional) A list (space or comma-separated) of macro defines needed by this module.
137
137
138
138
- searchpaths
139
139
- (Optional) A space-separated list of internal include paths, relative to the module's parent folder, which need to be added to a project's header search path.
- (Optional) A number indicating the minimum C++ language standard that is required for this module and this platform exclusively. This must be just the standard number with no prefix e.g. 20 for C++20.
- (Optional) A space-separated list of internal include paths, relative to the module's parent folder, which need to be added to a project's header search path.
0 commit comments