831f84a47b
Add my vkb config script.
...
It's a bit ugly, but it does nicely demonstrate what can be done with QF's
input system.
2013-01-29 16:40:46 +09:00
3e38c4aa48
Merge branch 'qfcc-cse'
...
qfcc now does local common subexpression elimination. It seems to work, but
is optional (default off): use -O to enable. Also, uninitialized variable
detection is finally back :)
The progs engine now has very basic valgrind-like functionality for
checking pointer accesses. Enable with pr_boundscheck 2
2012-12-13 20:17:28 +09:00
054d902d3a
Document alias defs.
...
The diagram showing the basics of how alias defs work is in a spearate file
because it created to much clutter in the header file.
2012-12-09 19:43:12 +09:00
215856045f
Clean up some bitrot in docstrap.
...
The configuration file had been renamed.
Also, mention docstrap in INSTALL and make the documentaion configure check
for the required tools (doxygen, dot (graphvis), mscgen, and transfig).
2012-12-06 11:50:29 +09:00
f8f01fc9fb
Change glx to x11 in the examples.
2012-08-12 09:20:20 +09:00
f1854c85b2
Fix some doxygen warnings and errors.
2012-07-15 07:39:50 +09:00
edf4ea84a1
Update the doxygen config for 1.8
2012-06-28 18:01:17 +09:00
bc1b483525
Nuke the rcsid stuff.
...
It's pretty useless in git.
2012-04-22 10:56:32 +09:00
b13a2b6dbd
Move screenshots to $fs_userpath/QF.
...
I got tired of screenshots getting scatter across the tree. ShotsPath in
the dirconf can override this.
2012-01-05 17:07:27 +09:00
e9ab230626
Docs: minor cleanups
2011-12-15 00:13:56 -05:00
69aa6c0e7e
Work around an apparent Doxygen 1.7.6 bug.
...
For some reason, the construct \c " in config.dox makes the custom \QF
command fail to work for the rest of the file, and escaping the quote
doesn't help. Work around for now by using words.
2011-12-14 23:06:36 -05:00
1c590116af
Docs: make sure the nav-tree is black, dammit.
2011-12-14 23:02:21 -05:00
d32fa834cc
Make links to the cvar/cmd lists.
2011-12-11 18:40:02 +09:00
8bab548d16
Make the hud type configurable via dirconf.
...
Currently only "id", "hipnotic" and "rogue" are supported (anything else is
treated as "id"). Has no effect in quakeworld (good thing too: changing
gamedirs is a little broken).
2011-09-11 08:13:26 +09:00
8c67a872c6
Add the gib docs to make dist.
2011-09-09 17:29:13 +09:00
272e955f18
Fix the version reporting.
...
$Id doesn't work in git, and didn't really report the right version anyway.
2011-09-08 19:11:43 +09:00
6f4d918c66
Begin documenting sound and tidy up specifications.
2011-09-08 14:38:57 +09:00
1dda097c65
Document the command line console command interface.
2011-09-08 13:06:11 +09:00
79cec9d7b5
Create a template file for our documentation.
2011-09-08 11:46:46 +09:00
e72d4923aa
Finish up the docs for cvars and config files.
...
For now, anyway :)
2011-09-08 10:28:48 +09:00
6a7b316572
Put my text editing vim settings into the docs.
...
Vim's autoformating doesn't like our style of comments, so I have to force
it to do what I want. Having to set the appropriate options every time I
edit a file got to be a RPITA, so time to get the computer to do it for me
:)
2011-09-08 10:17:58 +09:00
1e827485ef
Do some work on the user documentation.
...
Also document part of the cvar api.
2011-09-07 21:08:37 +09:00
a56f6b2e37
Docs: switch to SVG for the .fig files, add borders around imgs
...
Self-explanatory, really.
2011-08-23 01:39:40 -04:00
8b23e0e7f0
Fix yet another typo :P
2011-08-20 20:26:41 +09:00
d14eff6c76
Run the docs through aspell.
2011-08-20 19:55:54 +09:00
373f136fe6
Fix a typo.
2011-08-20 19:39:47 +09:00
f49a41b4b2
Comment on our lack of mp3 support.
2011-08-20 19:31:01 +09:00
46f9c9b105
Document QF's tracklists.
2011-08-20 19:24:14 +09:00
6268bd2965
Tweak the property list docs a little.
2011-08-20 19:23:31 +09:00
a759a5a376
Make the property-list documentation useful for users.
2011-08-20 16:29:59 +09:00
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
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
f7b52e0e15
Convert and link INSTALL into our doxygen docs.
2011-08-16 14:17:17 +09:00
d6dc09d9f9
Re-enable the buglist.
2011-07-29 13:36:50 +09:00
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
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
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
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
d910c14935
Clean up some doxygen warnings.
2011-07-10 19:12:07 +09:00
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
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
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
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
087fe0015e
Add the need to check client delta updates.
2010-12-22 08:56:32 +09:00
7853366697
Document the server connection commands.
2010-12-21 17:15:56 +09:00
9a037c8d6a
Some more qtv docs (mostly overview/status).
2010-12-21 16:44:05 +09:00
1018203f19
Begin documenting qtv.
2010-12-21 09:25:17 +09:00
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
98da73ae70
Move the qtv(qwtv) overview to the common doc directory.
2010-12-21 09:19:39 +09:00
d272775613
Reverse the colors for pre.fragment
...
This makes verbatime blocks easier on my eyes.
2010-12-19 11:35:47 +09:00
Bill Currie
Jeff Teunissen