annotate docs/man3/SDL_GetError.3 @ 4107:4e3b250c950e SDL-1.2

Erik Heckers fixed bug #493 Searching the installed man pages for SDL functions fails, e.g. man -k SDL_ |grep Video After investigating this I found that "makewhatis", the tool that generates the "whatis" database, reads the SDL_* man pages, but doesn't produce entries in the "whatis" database for the SDL_* man pages. After some more debugging I found the reason is a missing space. After editing SDL_Init.3(.gz) and replacing SDL_Init\- Initializes SDL with SDL_Init \- Initializes SDL everything works fine. After running "makewhatis" I can successfully do a man -k SDL_ and SDL_Init is listed in the output.
author Sam Lantinga <slouken@libsdl.org>
date Sat, 29 Dec 2007 02:34:53 +0000
parents e5bc29de3f0a
children 1238da4a7112
rev   line source
181
e5bc29de3f0a Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
1 .TH "SDL_GetError" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
e5bc29de3f0a Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
2 .SH "NAME"
4107
4e3b250c950e Erik Heckers fixed bug #493
Sam Lantinga <slouken@libsdl.org>
parents: 181
diff changeset
3 SDL_GetError \- Get SDL error string
181
e5bc29de3f0a Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
4 .SH "SYNOPSIS"
e5bc29de3f0a Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
5 .PP
e5bc29de3f0a Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
6 \fB#include "SDL/SDL\&.h"
e5bc29de3f0a Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
7 .sp
e5bc29de3f0a Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
8 \fBchar *\fBSDL_GetError\fP\fR(\fBvoid\fR);
e5bc29de3f0a Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
9 .SH "DESCRIPTION"
e5bc29de3f0a Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
10 .PP
e5bc29de3f0a Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
11 \fBSDL_GetError\fP returns a NULL terminated string containing information about the last internal SDL error\&.
e5bc29de3f0a Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
12 .SH "RETURN VALUE"
e5bc29de3f0a Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
13 .PP
e5bc29de3f0a Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
14 \fBSDL_GetError\fP returns a string containing the last error\&.
e5bc29de3f0a Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
15 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00