Bill Currie
373f136fe6
Fix a typo.
2011-08-20 19:39:47 +09:00
Bill Currie
f49a41b4b2
Comment on our lack of mp3 support.
2011-08-20 19:31:01 +09:00
Bill Currie
46f9c9b105
Document QF's tracklists.
2011-08-20 19:24:14 +09:00
Bill Currie
6268bd2965
Tweak the property list docs a little.
2011-08-20 19:23:31 +09:00
Bill Currie
a759a5a376
Make the property-list documentation useful for users.
2011-08-20 16:29:59 +09:00
Bill Currie
14c23879b1
Add a shortcut for QuakeForge.
...
I got tired of typing QuakeForge all the time, and to ensure consistency,
made it so \QF or @QF will expand to QuakeForge in the generated docs.
2011-08-20 16:11:24 +09:00
Bill Currie
605d60167d
Rename the doxygen formatted text files.
...
So I don't have to keep duplicating file names all over the place, I've
decided to use the "dox" extension on text files that are formatted for
doxygen processing. This way, doxygen can search for them using wildcards,
and unformated text files won't cause any headaches.
2011-08-20 13:35:51 +09:00
Bill Currie
f7b52e0e15
Convert and link INSTALL into our doxygen docs.
2011-08-16 14:17:17 +09:00
Bill Currie
d6dc09d9f9
Re-enable the buglist.
2011-07-29 13:36:50 +09:00
Jeff Teunissen
c7c646a53f
Makefile portability fixes
...
Allow our makefiles to build with non-GNU 'make' implementations.
Required some renaming of not-really-QuakeC source to .r to get it right.
2011-07-25 17:22:44 -04:00
Jeff Teunissen
30040d4d14
update doxygen 1.7.4 layout format
...
They added an "intro" key, which I don't grok yet. When I find out WTF
it means, I'll probably add some text.
2011-07-25 17:22:44 -04:00
Jeff Teunissen
5ef92009f0
Switch to SVG images for docs.
...
Doxygen 1.7.3 added support for SVG output from dot, so let's use it.
2011-07-25 17:22:44 -04:00
Jeff Teunissen
9d2a3d2545
Docs: Re-enable bolding
...
also, make CODE tags bold, to help them stand out a little more.
2011-07-25 17:22:44 -04:00
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
