aniani/trader
1
0
Fork 0
mirror of https://git.zap.org.au/git/trader.git synced 2024-11-03 17:27:29 -05:00
Code

Clean up help.c and help.h: remove superfluous lines, add comments

Browse Source
This commit is contained in:
John Zaitseff 2011-07-19 23:07:26 +10:00
parent b10b4c21ed
commit d47848850f
2 changed files with 20 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/help.c
View File

@ -9,7 +9,7 @@
Author: John Zaitseff <J.Zaitseff@zap.org.au> Author: John Zaitseff <J.Zaitseff@zap.org.au>
$Id$ $Id$
This file, help.c, contains the actual implementation of help routines This file, help.c, contains the actual implementation of help functions
as used in Star Traders. as used in Star Traders.
@ -35,7 +35,7 @@
* Help text definition * * Help text definition *
************************************************************************/ ************************************************************************/
const char *help_text[] = { static const char *help_text[] = {
"^BStar Traders^N is a simple game of interstellar trading. The object of the\n" "^BStar Traders^N is a simple game of interstellar trading. The object of the\n"
"game is to amass the greatest amount of wealth possible. This is done by\n" "game is to amass the greatest amount of wealth possible. This is done by\n"
"creating interstellar shipping lanes, expanding them and buying shares in\n" "creating interstellar shipping lanes, expanding them and buying shares in\n"
@ -149,6 +149,10 @@ const char *help_text[] = {
* Help text function definitions * * Help text function definitions *
************************************************************************/ ************************************************************************/
// This function is documented in the file "help.h"
/***********************************************************************/
void show_help (void) void show_help (void)
{ {
int curpage = 0; int curpage = 0;
@ -156,15 +160,15 @@ void show_help (void)
bool done = false; bool done = false;
// Count how many pages appear in the help text
for (numpages = 0; help_text[numpages] != NULL; numpages++) { for (numpages = 0; help_text[numpages] != NULL; numpages++) {
; ;
} }
if (numpages == 0) { if (numpages == 0)
return; return;
}
newtxwin(23, 80, LINE_OFFSET+1, COL_CENTER(80)); newtxwin(WIN_LINES - 1, WIN_COLS, LINE_OFFSET + 1, COL_CENTER(WIN_COLS));
while (! done) { while (! done) {
// Display a page of instructions // Display a page of instructions
@ -247,7 +251,6 @@ void show_help (void)
waddch(curwin, *s | curattr); waddch(curwin, *s | curattr);
break; break;
} }
break; break;
case '~': case '~':
@ -314,7 +317,6 @@ void show_help (void)
waddch(curwin, *s | curattr); waddch(curwin, *s | curattr);
break; break;
} }
break; break;
default: default:

13
src/help.h
View File

@ -9,8 +9,8 @@
Author: John Zaitseff <J.Zaitseff@zap.org.au> Author: John Zaitseff <J.Zaitseff@zap.org.au>
$Id$ $Id$
This file, help.h, contains declarations for help text routines as used This file, help.h, contains declarations for help functions as used in
in Star Traders. Star Traders.
This program is free software: you can redistribute it and/or modify it This program is free software: you can redistribute it and/or modify it
@ -36,6 +36,15 @@
* Help text function prototypes * * Help text function prototypes *
************************************************************************/ ************************************************************************/
/*
Function: show_help - Show instructions on how to play the game
Parameters: (none)
Returns: (nothing)
This function displays instructions on how to play Star Traders in a
Curses window. It does not depend on any global game variable. On
exit, the previous screen is restored and refreshed.
*/
extern void show_help (void); extern void show_help (void);