From 6a7b316572a07df84c6ea41e91573595aac39677 Mon Sep 17 00:00:00 2001 From: Bill Currie Date: Thu, 8 Sep 2011 10:17:58 +0900 Subject: [PATCH] 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 :) --- INSTALL | 1 + doc/bind.dox | 1 + doc/config.dox | 1 + doc/connect.dox | 1 + doc/cshifts.dox | 1 + doc/dirconf.dox | 1 + doc/faq.dox | 1 + doc/filesystem.dox | 1 + doc/mapformat.dox | 1 + doc/property-list.dox | 1 + doc/qtv.dox | 1 + doc/quakeforge.dox | 1 + doc/qw-cap-spec.dox | 1 + doc/qw-download-spec.dox | 1 + doc/surround-sound.dox | 1 + doc/timestamps.dox | 1 + doc/tracklist.dox | 1 + 17 files changed, 17 insertions(+) diff --git a/INSTALL b/INSTALL index 7e4c4be88..fe696aa1c 100644 --- a/INSTALL +++ b/INSTALL @@ -1,5 +1,6 @@ //This file is formatted for processing with doxygen. //unfortunatly, have to wrap the docs in a C comment for doxygen +// vim:tw=74:formatoptions-=l /** \page build-install Building and Installing QuakeForge diff --git a/doc/bind.dox b/doc/bind.dox index a5566d7a9..99b006a60 100644 --- a/doc/bind.dox +++ b/doc/bind.dox @@ -1,4 +1,5 @@ //unfortunately, have to wrap the docs in a C comment for doxygen +// vim:tw=74:formatoptions-=l /** \page key_binding New Bind System diff --git a/doc/config.dox b/doc/config.dox index 98d0c32dd..a047216c8 100644 --- a/doc/config.dox +++ b/doc/config.dox @@ -1,4 +1,5 @@ //unfortunately, have to wrap the docs in a C comment for doxygen +// vim:tw=74:formatoptions-=l /** \page run_config Runtime Configuration. diff --git a/doc/connect.dox b/doc/connect.dox index 44f7fcd27..44d83586a 100644 --- a/doc/connect.dox +++ b/doc/connect.dox @@ -1,4 +1,5 @@ //unfortunately, have to wrap the docs in a C comment for doxygen +// vim:tw=74:formatoptions-=l /** \page connection_sequence QW Connection Sequence \msc diff --git a/doc/cshifts.dox b/doc/cshifts.dox index 3514906a9..623419a8b 100644 --- a/doc/cshifts.dox +++ b/doc/cshifts.dox @@ -1,4 +1,5 @@ //unfortunately, have to wrap the docs in a C comment for doxygen +// vim:tw=74:formatoptions-=l /** \page cshift_cvars cshift control diff --git a/doc/dirconf.dox b/doc/dirconf.dox index 6886937a7..6e37df11c 100644 --- a/doc/dirconf.dox +++ b/doc/dirconf.dox @@ -1,4 +1,5 @@ //unfortunately, have to wrap the docs in a C comment for doxygen +// vim:tw=74:formatoptions-=l /** \page dirconf Directory Configuration diff --git a/doc/faq.dox b/doc/faq.dox index 4958eefe9..73c0d09e9 100644 --- a/doc/faq.dox +++ b/doc/faq.dox @@ -1,4 +1,5 @@ //unfortunately, have to wrap the docs in a C comment for doxygen +// vim:tw=74:formatoptions-=l /** \page faq Frequently Asked Questions diff --git a/doc/filesystem.dox b/doc/filesystem.dox index 699e7064a..cfdefb502 100644 --- a/doc/filesystem.dox +++ b/doc/filesystem.dox @@ -1,4 +1,5 @@ //unfortunately, have to wrap the docs in a C comment for doxygen +// vim:tw=74:formatoptions-=l /** \page filesystem QuakeForge Directory Trees diff --git a/doc/mapformat.dox b/doc/mapformat.dox index c3624800e..9a1c66ccc 100644 --- a/doc/mapformat.dox +++ b/doc/mapformat.dox @@ -1,4 +1,5 @@ //unfortunately, have to wrap the docs in a C comment for doxygen +// vim:tw=74:formatoptions-=l /** \page mapformat Map (.map) File Format diff --git a/doc/property-list.dox b/doc/property-list.dox index e2c680fb2..8be3f3b70 100644 --- a/doc/property-list.dox +++ b/doc/property-list.dox @@ -1,4 +1,5 @@ //unfortunately, have to wrap the docs in a C comment for doxygen +// vim:tw=74:formatoptions-=l /** \page property-list Property List diff --git a/doc/qtv.dox b/doc/qtv.dox index 9fedff083..90aba3bc8 100644 --- a/doc/qtv.dox +++ b/doc/qtv.dox @@ -1,4 +1,5 @@ //unfortunately, have to wrap the docs in a C comment for doxygen +// vim:tw=74:formatoptions-=l /** \page qtv_overview QF QTV overview/status. OVERVIEW: diff --git a/doc/quakeforge.dox b/doc/quakeforge.dox index c8a624a50..e21a7fd27 100644 --- a/doc/quakeforge.dox +++ b/doc/quakeforge.dox @@ -1,4 +1,5 @@ //unfortunately, have to wrap the docs in a C comment for doxygen +// vim:tw=74:formatoptions-=l /** \mainpage QuakeForge diff --git a/doc/qw-cap-spec.dox b/doc/qw-cap-spec.dox index 7bcb18500..05796a3d0 100644 --- a/doc/qw-cap-spec.dox +++ b/doc/qw-cap-spec.dox @@ -1,4 +1,5 @@ //unfortunately, have to wrap the docs in a C comment for doxygen +// vim:tw=74:formatoptions-=l /** \page qw_cap_spec QW Capabilities String diff --git a/doc/qw-download-spec.dox b/doc/qw-download-spec.dox index 140e71e55..852f12065 100644 --- a/doc/qw-download-spec.dox +++ b/doc/qw-download-spec.dox @@ -1,4 +1,5 @@ //unfortunately, have to wrap the docs in a C comment for doxygen +// vim:tw=74:formatoptions-=l /** \page qw_download_spec QW Download Specification diff --git a/doc/surround-sound.dox b/doc/surround-sound.dox index 881ad5547..d5a080685 100644 --- a/doc/surround-sound.dox +++ b/doc/surround-sound.dox @@ -1,4 +1,5 @@ //unfortunately, have to wrap the docs in a C comment for doxygen +// vim:tw=74:formatoptions-=l /** \page surround_sound_spec Description of Surround-Sound Channels diff --git a/doc/timestamps.dox b/doc/timestamps.dox index d024d7e41..4e8a75aae 100644 --- a/doc/timestamps.dox +++ b/doc/timestamps.dox @@ -1,4 +1,5 @@ //unfortunately, have to wrap the docs in a C comment for doxygen +// vim:tw=74:formatoptions-=l /** \page server_timestamps Server Log Timestamps diff --git a/doc/tracklist.dox b/doc/tracklist.dox index c298a88f0..de0dfc6d7 100644 --- a/doc/tracklist.dox +++ b/doc/tracklist.dox @@ -1,4 +1,5 @@ //unfortunately, have to wrap the docs in a C comment for doxygen +// vim:tw=74:formatoptions-=l /** \page tracklist Tracklist config file