Commit graph

254 commits

Author SHA1 Message Date
Bill Currie
d910c14935 Clean up some doxygen warnings. 2011-07-10 19:12:07 +09:00
Jeff Teunissen
26bfc4b394 Fix parameter names in documentation bodies
In \param sections within function/etc. docs, argument names were being
displayed with the same formatting they are in the prototype...very ugly
on the background they're on. Make 'em white.
2011-07-09 23:30:09 -04:00
Jeff Teunissen
b1f8e7e823 Add stuff from doxygen 1.7.4
New doxygen makes our docs all ugly, let's give 'em a face lift.
2011-07-09 23:30:09 -04:00
Jeff Teunissen
cb86e09029 Rualib: documentation updates.
Add a layout file for Rua docs and create groups for its library functions.
2011-06-14 13:31:30 -04:00
Bill Currie
29adc2ed92 Add a todo item.
I'd forgotten I wanted to do playback, but was reminded by OneManClan when
he asked about it in a general sense.
2010-12-23 09:43:34 +09:00
Bill Currie
087fe0015e Add the need to check client delta updates. 2010-12-22 08:56:32 +09:00
Bill Currie
7853366697 Document the server connection commands. 2010-12-21 17:15:56 +09:00
Bill Currie
9a037c8d6a Some more qtv docs (mostly overview/status). 2010-12-21 16:44:05 +09:00
Bill Currie
1018203f19 Begin documenting qtv. 2010-12-21 09:25:17 +09:00
Bill Currie
1b2a5d69f5 Make documentation of static functions configurable.
Deek doesn't want docs for static functions, but I do. When two developers
disagree on something like this, there's only one thing to do :)
2010-12-21 09:21:30 +09:00
Bill Currie
98da73ae70 Move the qtv(qwtv) overview to the common doc directory. 2010-12-21 09:19:39 +09:00
Bill Currie
d272775613 Reverse the colors for pre.fragment
This makes verbatime blocks easier on my eyes.
2010-12-19 11:35:47 +09:00
Jeff Teunissen
a8e3d5d527 Doc fixes
Tweak colors, add borders around some images, remove static definitions
from engine docs.
2010-12-16 06:24:54 -05:00
Jeff Teunissen
28338bc74e Turn off timestamping in HTML docs
The pointless deltas were slowing rsync down more than I'd like, and it's
not as if that information is all THAT useful. Nuke it.
2010-12-13 13:20:26 -05:00
Jeff Teunissen
d9e97e27a2 Doxygen formatting updates
Doxygen-produced HTML docs now look a lot more like the web site, and
are now more attractive in general. :)
2010-12-13 03:28:34 -05:00
Bill Currie
813e2010da Some basic documentation on the QuakeForge file system. 2010-11-27 20:56:32 +09:00
Bill Currie
ab70ec2a8f Sort the group names. 2010-10-13 20:52:08 +09:00
Bill Currie
fcd1897421 Create the qfbsp doxygen modules.
Also, make doxygen extract static functions as well, so qfbsp's docs can be
more complete.
2010-10-13 20:52:08 +09:00
Bill Currie
ea22ec1271 Add documentation for the directory configuration. 2010-08-25 13:31:23 +09:00
Jeff Teunissen
4452c31859 Pull in changes from master 2010-08-23 00:03:46 -04:00
Jeff Teunissen
b5375449e9 Guess I had it pretty-much right already.
Rename TOPDIR to TOPSRC, can't get around requiring it and it's more
descriptive this way anyway. Also, revert the use of the m4_esyscmd()
macro in configure. It's kinda cool, but I'll come up with a better way
to do it.
2010-08-22 23:53:06 -04:00
Bill Currie
42a2e84cd5 much better charchart image
generated directly from the conchars data rather than an in-game hack. 2x
actual size.
2010-08-23 12:16:36 +09:00
Bill Currie
fb72aaf082 Start giving some structure to the non-code docs.
Use subpage instead of ref. This actually moves the so-referenced pages out
of "Related Pages". I imagine they'll form a tree in the menu, but I don't have
that config here.
2010-08-20 12:33:07 +09:00
Bill Currie
aede8e4c34 ancient in-joke
don't want to lose this
2010-08-20 11:45:23 +09:00
Jeff Teunissen
16e482eb90 Proof of concept for making docs build without main configure
We need to figure out a way to make docs in unusual places, like in the
SourceForge shell environment -- which doesn't have an extremely recent
autotools. This is an extremely stripped-down automake/autoconf setup that
provides the bare minimum needed to AC_SUBST variables.

It's dirty and hacky, but it kinda works.
2010-08-19 12:59:16 -04:00
Bill Currie
e236c1dd4e get the style of list that I wanted 2010-08-19 23:32:37 +09:00
Bill Currie
7052f8cf1e make the connection sequency pretty
(for certain values of pretty). we now require mscgen to build docs.
2010-08-19 21:29:29 +09:00
Bill Currie
43114f5e92 link the existing documentation into the doxygen docs 2010-08-19 20:03:50 +09:00
Bill Currie
140bd64080 make a local copy of the surround-sound channel assignents.
As found in the Vorbis documentation.
2010-08-12 02:38:53 +00:00
Bill Currie
96f1573136 doc tweaks 2010-08-11 23:48:08 +00:00
Bill Currie
4c7b2bb6f0 update for recent doxygen
removes warnings about obsolete options, but introduces a couple of weird
include path type warnings
2010-08-11 23:41:50 +00:00
Bill Currie
f04bc64ef1 clean up a bunch of doxygen warnings 2010-08-11 23:41:30 +00:00
Bill Currie
0dfff8fd58 ignore stuff 2010-08-07 10:42:09 +00:00
Bill Currie
6830bd47fa while neat, inlining the code was a bit too much 2010-08-06 03:03:17 +00:00
Bill Currie
397312b54b enable source code browsing 2010-08-06 01:13:47 +00:00
Bill Currie
bb6619d332 docs and a bit of cleanup
delete core files with boostrap clean
fix the placement of a comment
simple docs for the standard client connection process (no mention of
downloads)
2010-01-13 06:48:54 +00:00
Bill Currie
997102fea8 audit the usage of "only"
There are still a few iffy places (notably around certain prepositions), but
the relevant sentences are now much easier to read.
2010-01-13 06:42:26 +00:00
Bill Currie
8ee4da866b Part of my box-clipping efforts 2009-12-24 07:15:18 +00:00
Bill Currie
e9340b07ee there, now I have at least some clue :) 2007-10-06 03:53:02 +00:00
Bill Currie
dd90267beb initial docs for the map files because I never did quite understand the texture information. (still don't, but once I doc it, it won't matter if I forget it:) 2007-10-06 03:19:21 +00:00
Bill Currie
7af2378e03 turn on graph generation in the doxygen output. very slow, but the diagrams are worth it. Also make the data member of sfx_t a union rather than void so doxygen can see the relationships (and gets rid of a bunch of casts that I never liked anyway). 2007-05-07 05:20:24 +00:00
Timothy C. McGrath
784673aa16 Update FAQ so people who get stumped by trying to build svn and get configure syntax errors will know what to do. Hikaru 2007-03-24 10:17:05 +00:00
Bill Currie
f71d3da578 rename http to download is the spec is fairly generic 2007-03-22 07:37:18 +00:00
Bill Currie
1fc20e70b3 external documentation of *cap info key 2007-03-21 12:05:10 +00:00
Bill Currie
aae9157f43 add the data block 2007-03-21 11:23:11 +00:00
Bill Currie
b460656e69 basic specs for the http extension to downloads (as a bonus, includes the specs for the gzipped downloads, as such). 2007-03-21 11:18:12 +00:00
Bill Currie
ec49387743 update the year 2007-03-17 03:23:39 +00:00
Jeff Teunissen
286d688926 Add the re-discovered missing QF logo Blender data file. 2007-03-09 10:58:26 +00:00
Bill Currie
7d1832052b not strictly accurate, but don't want to lose it 2007-02-09 09:21:51 +00:00
Bill Currie
6fbddc3d43 so that's the right way to do groups and subgroups... 2006-12-05 11:40:00 +00:00
Bill Currie
6426f41ea6 more cleanup 2006-12-01 09:28:43 +00:00
Bill Currie
63e93399d4 bit of a tidyup 2006-12-01 09:13:49 +00:00
Bill Currie
3fb03fc2be hah, should have been using __attribute__((used)) all that time (rather
than __attribute__((unused))). fixes the missing console in -x11
2005-08-04 15:27:09 +00:00
Bill Currie
5d509bea81 tweakage 2005-07-27 12:42:27 +00:00
Bill Currie
e3c9cfd3d2 some documentation work 2005-07-27 12:14:35 +00:00
Bill Currie
762aefc9b1 implement Raven's calling convention (rcall: first 2 params in opb and
opc). should give a general speedup to most progs.
2005-06-12 09:54:01 +00:00
Ragnvald Maartmann-Moe IV
f34dc8f884 A few more backward compatibility cvar links. 2005-03-24 15:12:19 +00:00
Bill Currie
8770df39e5 start documenting things (progs building still borked)
This is an imperfect revision of history.
2004-11-08 23:27:00 +00:00
Bill Currie
5dc5c280a4 more recent version of DrSpliff's qfadmin script (1.17 2003/03/28) 2004-04-05 04:28:31 +00:00
Bill Currie
de630d850a another year goes by... 2004-01-22 07:02:10 +00:00
Bill Currie
52968be46d ashridah's file based cd plugin (ie, it will play any sound file QF can
load as background music).
2004-01-20 06:58:42 +00:00
Bill Currie
4f66e8fc60 don't run doxygen in Forge: it doesn't grok Objective-C 2004-01-11 05:56:10 +00:00
Bill Currie
8d42963c4d start documenting the progs engine. memory map initially 2004-01-07 02:52:52 +00:00
Bill Currie
9a97ee400b remove obsolete settings 2003-11-03 18:58:35 +00:00
Ragnvald Maartmann-Moe IV
dc8e9422a2 Qize's patches. Add some more backwards-compatibility aliases to ln.gib,
remove a dead cvar, and don't display a message about what to do to connect
when use +connect already...
2003-09-01 01:52:20 +00:00
Bill Currie
ef4ca0c798 some doxygen tweaks 2003-08-31 05:24:24 +00:00
Ragnvald Maartmann-Moe IV
0a7b56f003 show_fps -> hud_fps, show_ping -> hud_ping, show_pl -> hud_pl,
show_time -> hud_time, show_scoresuid -> hud_scoreboard_uid
2003-07-27 23:20:11 +00:00
Brian Koropoff
59db43b377 This is totally out of date now. 2003-07-17 17:55:09 +00:00
Bill Currie
454aa5c603 more mailing list corrections 2003-07-12 21:50:22 +00:00
Bill Currie
1bdcd879be initial work on dynamic view support for the console. I'm aware that
QF/view.h vs view.h may cause some confusion, but I'm hoping to eleminate
view.h.

Also put the sample hud.txt into docs so it doesn't get lost.
2003-05-05 18:50:14 +00:00
Bill Currie
789c7f47d6 update the copyright year 2003-05-05 18:35:28 +00:00
Brian Koropoff
645b7ca3d6 New version of infobot.gib that supports factoid locking, and an
insignificant change to the GIB docs.
2003-04-11 02:36:10 +00:00
Bill Currie
b80357afda change _FOpenFile to take a dstring for foundname plugging a potential
buffer overflow.
2003-04-09 05:55:41 +00:00
Bill Currie
c1b587c2ce include qfadmin in the dist tarball 2003-03-13 01:21:54 +00:00
Bill Currie
2aee6a7734 preliminary doxygen support 2003-03-10 23:42:27 +00:00
Brian Koropoff
cd3fc3569b Fixed a bug on out-of-bounds array access attempts and enhanced the now-
functioning infobot.gib.
2003-03-01 07:24:58 +00:00
Brian Koropoff
2364c49741 Add DrSpliff's qfadmin GIB script to CVS. 2003-02-26 02:28:10 +00:00
Brian Koropoff
d47aa718f7 Added a line to the latex preamble to use postscript fonts on PS/PDF
ouput.  This makes the PDF version much more readable, especially in
acrobat.
2003-02-26 02:18:11 +00:00
Brian Koropoff
020a9262f7 Made the parser anal about concatenation usage and fixed several bugs by
running /dev/urandom through carne to catch problems.
2003-02-25 08:04:48 +00:00
Brian Koropoff
fe8161c036 Might as well spell check what I have so far... 2003-02-23 05:10:14 +00:00
Brian Koropoff
e338dd4672 Finished up the section on flow control and outlined the section on
functions.  Added example script output to figures.
2003-02-23 05:08:15 +00:00
Brian Koropoff
d85639d65e Added more to the GIB docs. 2003-02-23 03:20:53 +00:00
Brian Koropoff
5acf0bbeda Fixed a bug in the 'contains' GIB builtin and added more to the GIB docs. 2003-02-22 07:19:51 +00:00
Brian Koropoff
5d634d6874 Wrote some more of the GIB docs. Writing this stuff is brutal. 2003-02-21 23:48:35 +00:00
Brian Koropoff
00b3083a57 Added the beginnings of GIB documentation. 2003-02-21 21:33:36 +00:00
Bill Currie
03505e80d1 add the gib scripts to the distribution tarball 2003-02-18 17:25:58 +00:00
Brian Koropoff
f6da3baa1e Temporarily fixed GIB filesystem access until I can work out a system that
better meshes with the new QFS.  Fixed up some GIB scripts a bit.
2003-02-16 21:27:18 +00:00
Brian Koropoff
af165dcc59 Added an extensible server-side infobot written in GIB. 2003-02-16 19:54:41 +00:00
Brian Koropoff
9d3d4e0638 Updated the header to zoom.gib, removed cb.gib pending a rewrite for the
new version of GIB, and added two scripts from alphageek.
2003-02-14 08:36:39 +00:00
Brian Koropoff
47d35f3e2d GIB: Added ifnot, fixed several bugs, updated zoom.gib yet again. 2003-01-31 03:43:56 +00:00
Brian Koropoff
783602e6a4 D'oh! 2003-01-31 01:42:56 +00:00
Brian Koropoff
748985b760 Updated zoom.gib to work with the new version of GIB. 2003-01-31 00:12:04 +00:00
Bill Currie
761a7546dd re-arrange things so __attribute__ and __builtin_expect are properly
autoconfiscated so rcsid will continue to work with gcc 3.3
2003-01-15 15:31:36 +00:00
Bill Currie
a4dfef63c3 make all files with rcsid include config.h 2003-01-14 20:18:29 +00:00
Brian Koropoff
19ac57dafc Fixed a bug with aliases and updated cb.gib a bit. 2002-12-14 20:34:20 +00:00
Brian Koropoff
32e5e6ef0b Numerous GIB bug fixes and optimizations. Fixed/updated some GIB scripts
as well.
2002-12-13 23:36:05 +00:00
Brian Koropoff
0a8ff6a8cf In addition to .gib files, anything exec'ed from within a GIB buffer is now
put in a new buffer on the stack and stripped of comments.  Fixed an
instance of a function name that I forgot to change in cb.gib.
2002-12-03 05:54:13 +00:00
Brian Koropoff
44d0408a38 Two small fixes. 2002-11-12 02:53:24 +00:00
Brian Koropoff
0f71b02fd7 Changed the name of GIB builtins from string.length to string::length, etc.
Made a few miscellaneous cleanups and enhancements to builtins and changed
all the GIB scripts in CVS to reflect the new naming conventions.
2002-11-11 01:57:34 +00:00
Brian Koropoff
20d47cde2f Added the global.delete builtin to clean up old global variables. Updated
cb.gib to use it.
2002-10-23 03:56:57 +00:00