Simple Directmedia Layer
0
fork

Configure Feed

Select the types of activity you want to include in your feed.

SDL_filesystem.h: Fill in missing documentation.

+20 -13
+20 -13
include/SDL3/SDL_filesystem.h
··· 166 166 typedef enum SDL_Folder 167 167 { 168 168 SDL_FOLDER_HOME, /**< The folder which contains all of the current user's data, preferences, and documents. It usually contains most of the other folders. If a requested folder does not exist, the home folder can be considered a safe fallback to store a user's documents. */ 169 - 170 169 SDL_FOLDER_DESKTOP, /**< The folder of files that are displayed on the desktop. Note that the existence of a desktop folder does not guarantee that the system does show icons on its desktop; certain GNU/Linux distros with a graphical environment may not have desktop icons. */ 171 - 172 170 SDL_FOLDER_DOCUMENTS, /**< User document files, possibly application-specific. This is a good place to save a user's projects. */ 173 - 174 171 SDL_FOLDER_DOWNLOADS, /**< Standard folder for user files downloaded from the internet. */ 175 - 176 172 SDL_FOLDER_MUSIC, /**< Music files that can be played using a standard music player (mp3, ogg...). */ 177 - 178 173 SDL_FOLDER_PICTURES, /**< Image files that can be displayed using a standard viewer (png, jpg...). */ 179 - 180 174 SDL_FOLDER_PUBLICSHARE, /**< Files that are meant to be shared with other users on the same computer. */ 181 - 182 175 SDL_FOLDER_SAVEDGAMES, /**< Save files for games. */ 183 - 184 176 SDL_FOLDER_SCREENSHOTS, /**< Application screenshots. */ 185 - 186 177 SDL_FOLDER_TEMPLATES, /**< Template files to be used when the user requests the desktop environment to create a new file in a certain folder, such as "New Text File.txt". Any file in the Templates folder can be used as a starting point for a new file. */ 187 - 188 178 SDL_FOLDER_VIDEOS, /**< Video files that can be played using a standard video player (mp4, webm...). */ 189 - 190 179 SDL_FOLDER_COUNT /**< Total number of types in this enum, not a folder type by itself. */ 191 - 192 180 } SDL_Folder; 193 181 194 182 /** ··· 219 207 220 208 /* Abstract filesystem interface */ 221 209 210 + /** 211 + * Types of filesystem entries. 212 + * 213 + * Note that there may be other sorts of items on a filesystem: devices, 214 + * symlinks, named pipes, etc. They are currently reported as 215 + * SDL_PATHTYPE_OTHER. 216 + * 217 + * \since This enum is available since SDL 3.1.3. 218 + * 219 + * \sa SDL_PathInfo 220 + */ 222 221 typedef enum SDL_PathType 223 222 { 224 223 SDL_PATHTYPE_NONE, /**< path does not exist */ ··· 227 226 SDL_PATHTYPE_OTHER /**< something completely different like a device node (not a symlink, those are always followed) */ 228 227 } SDL_PathType; 229 228 229 + /** 230 + * Information about a path on the filesystem. 231 + * 232 + * \since This datatype is available since SDL 3.1.3. 233 + * 234 + * \sa SDL_GetPathInfo 235 + * \sa SDL_GetStoragePathInfo 236 + */ 230 237 typedef struct SDL_PathInfo 231 238 { 232 239 SDL_PathType type; /**< the path type */ ··· 237 244 } SDL_PathInfo; 238 245 239 246 /** 240 - * Flags for path matching 247 + * Flags for path matching. 241 248 * 242 249 * \since This datatype is available since SDL 3.1.3. 243 250 *