Commit Graph

201 Commits

Author SHA1 Message Date
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