Module: ngircd.git
Branch: master
Commit: be08349dcb2ed3e89040112a241e022ee802baa4
URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=be08349d…
Author: Alexander Barton <alex(a)barton.de>
Date: Sun Feb 24 18:53:10 2013 +0100
Commands.txt: Update description of the "INVITE" command
---
doc/Commands.txt | 15 +++++++++------
1 file changed, 9 insertions(+), 6 deletions(-)
diff --git a/doc/Commands.txt b/doc/Commands.txt
index 2d3cab2..2967b43 100644
--- a/doc/Commands.txt
+++ b/doc/Commands.txt
@@ -419,14 +419,17 @@ Channel Commands
~~~~~~~~~~~~~~~~
- INVITE
- INVITE <nick> <channel>
+ INVITE <nickname> <channel>
.
- Invites <nick> to <channel>.
- <channel> does not have to exist, but if it does, only members of the
- channel are allowed to invite other clients.
+ Invite <nickname> to join channel <channel>.
.
- If the <channel> mode "+i" is set, only <channel> operators may invite
- other clients.
+ <channel> does not have to exist, but if it does, only members of the
+ channel are allowed to invite other users. If the channel mode "+i"
+ is set, only channel "half-ops" (and above) may invite other clients,
+ and if channel mode "+V" is set, nobody can invite other users.
+
+ References:
+ - RFC 2812, 3.2.7 "Invite message"
- JOIN
JOIN <channels> [<channel-keys>]
Module: ngircd.git
Branch: master
Commit: b25fd8a98ca48abdabfe52ce3bfdd00a8f9fc003
URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=b25fd8a9…
Author: Alexander Barton <alex(a)barton.de>
Date: Sun Feb 24 18:53:33 2013 +0100
Commands.txt: Update description of the "KICK" command
---
doc/Commands.txt | 13 ++++++++++---
1 file changed, 10 insertions(+), 3 deletions(-)
diff --git a/doc/Commands.txt b/doc/Commands.txt
index 2967b43..92d25c7 100644
--- a/doc/Commands.txt
+++ b/doc/Commands.txt
@@ -441,11 +441,18 @@ Channel Commands
If the channel(s) do not exist, then they will be created.
- KICK
- KICK <channel> <nick> [<kick-message>]
+ KICK <channel>[,<channel>[,...]] <nickname>[,<nickname>[,...]] [<reason>]
.
- Remove <nick> from <channel>, optional with a <kick-message>.
+ Remove users(s) with <nickname>(s) from <channel>(s).
.
- Only <channel> operators are able to KICK.
+ There must be either exactly one <channel> parameter and multiple
+ <nickname> parameters, or as many <channel> parameters as there are
+ <nickname> parameters. The <reason> is shown to the users being
+ kicked, and the nickname of the current user is used when <reason>
+ is omitted.
+
+ References:
+ - RFC 2812, 3.2.8 "Kick command"
- LIST
LIST [<channels> [<server>]]
Module: ngircd.git
Branch: master
Commit: 883a8fa6f185033102748be6dde1b386ddef54ac
URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=883a8fa6…
Author: Alexander Barton <alex(a)barton.de>
Date: Sun Feb 24 16:14:13 2013 +0100
Add new _IRC_ARGC_BETWEEN_OR_RETURN_ macro to irc-macros.h
---
src/ngircd/irc-macros.h | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/src/ngircd/irc-macros.h b/src/ngircd/irc-macros.h
index bd63ec4..87a6088 100644
--- a/src/ngircd/irc-macros.h
+++ b/src/ngircd/irc-macros.h
@@ -40,6 +40,17 @@ if (Req->argc < Min) \
Client_ID(Client), Req->command);
/**
+ * Make sure that number of passed parameters is in between Min and Max.
+ *
+ * If there aren't at least Min parameters or if there are more than Max
+ * parameters, send an error to the client and return from the function.
+ */
+#define _IRC_ARGC_BETWEEN_OR_RETURN_(Client, Req, Min, Max) \
+if (Req->argc < Min || Req->argc > Max) \
+ return IRC_WriteStrClient(Client, ERR_NEEDMOREPARAMS_MSG, \
+ Client_ID(Client), Req->command);
+
+/**
* Get sender of an IRC command.
*
* The sender is either stored in the prefix if the command has been
Module: ngircd.git
Branch: master
Commit: 7f99f7c14f923c1e9aa8fe075a908c1e9e5b6239
URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=7f99f7c1…
Author: Alexander Barton <alex(a)barton.de>
Date: Sun Feb 24 16:20:27 2013 +0100
Add new _IRC_ARGC_EQ_OR_RETURN_ macro to irc-macros.h
---
src/ngircd/irc-macros.h | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/src/ngircd/irc-macros.h b/src/ngircd/irc-macros.h
index 87a6088..f0c0f36 100644
--- a/src/ngircd/irc-macros.h
+++ b/src/ngircd/irc-macros.h
@@ -18,6 +18,17 @@
*/
/**
+ * Make sure that number of passed parameters is equal to Count.
+ *
+ * If there are not exactly Count parameters, send an error to the client and
+ * return from the function.
+ */
+#define _IRC_ARGC_EQ_OR_RETURN_(Client, Req, Count) \
+if (Req->argc != Count) \
+ return IRC_WriteStrClient(Client, ERR_NEEDMOREPARAMS_MSG, \
+ Client_ID(Client), Req->command);
+
+/**
* Make sure that number of passed parameters is less or equal than Max.
*
* If there are more than Max parameters, send an error to the client and
Module: ngircd.git
Branch: master
Commit: bd1b72718758c7f49aaab31a1bb34018880c10aa
URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=bd1b7271…
Author: Alexander Barton <alex(a)barton.de>
Date: Fri Feb 22 18:11:26 2013 +0100
Update Doxygen configuration
---
doc/src/Doxyfile | 105 ++++++++---------------------------------------
doc/src/footer.inc.html | 2 +-
2 files changed, 18 insertions(+), 89 deletions(-)
diff --git a/doc/src/Doxyfile b/doc/src/Doxyfile
index 8afec5e..6d9ccb5 100644
--- a/doc/src/Doxyfile
+++ b/doc/src/Doxyfile
@@ -16,106 +16,55 @@
# Project related configuration options
#---------------------------------------------------------------------------
-# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
-# by quotes) that should identify the project.
+DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = ngIRCd
-
-# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
-# base path where the generated documentation will be put.
-# If a relative path is entered, it will be relative to the location
-# where doxygen was started. If left blank the current directory will be used.
+PROJECT_BRIEF = "Lightweight Internet Relay Chat server"
+PROJECT_LOGO = "../../contrib/ngIRCd-Logo.gif"
OUTPUT_DIRECTORY = .
-
-# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
-# can be used to strip a user-defined part of the path. Stripping is
-# only done if one of the specified strings matches the left-hand part of
-# the path. The tag can be used to show relative paths in the file list.
-# If left blank the directory from which doxygen is run is used as the
-# path to strip.
-
STRIP_FROM_PATH = ../..
-# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
-# will interpret the first line (until the first dot) of a JavaDoc-style
-# comment as the brief description. If set to NO, the JavaDoc
-# comments will behave just like the Qt-style comments (thus requiring an
-# explicit @brief command for a brief description.
-
JAVADOC_AUTOBRIEF = YES
-
-# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
-# sources only. Doxygen will then generate output that is more tailored for C.
-# For instance, some of the names that are used will be different. The list
-# of all members will be omitted, etc.
-
OPTIMIZE_OUTPUT_FOR_C = YES
+TYPEDEF_HIDES_STRUCT = YES
+
+TAB_SIZE = 8
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
-# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
-# documentation are documented, even if no documentation was available.
-# Private class members and static file members will be hidden unless
-# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
-
EXTRACT_ALL = YES
-
-# If the EXTRACT_STATIC tag is set to YES all static members of a file
-# will be included in the documentation.
-
EXTRACT_STATIC = YES
-# If the sources in your project are distributed over multiple directories
-# then setting the SHOW_DIRECTORIES tag to YES will show the directory
-# hierarchy in the documentation. The default is NO.
-
SHOW_DIRECTORIES = YES
#---------------------------------------------------------------------------
-# configuration options related to the input files
+# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
-# The INPUT tag can be used to specify the files and/or directories that
-# contain documented source files. You may enter file names like "myfile.cpp"
-# or directories like "/usr/src/myproject". Separate the files or directories
-# with spaces.
+QUIET = NO
+WARNINGS = YES
+WARN_IF_UNDOCUMENTED = YES
+WARN_IF_DOC_ERROR = YES
+WARN_NO_PARAMDOC = YES
-INPUT = ../../src
-
-# The RECURSIVE tag can be used to turn specify whether or not subdirectories
-# should be searched for input files as well. Possible values are YES and NO.
-# If left blank NO is used.
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+INPUT = ../../src
+INPUT_ENCODING = UTF-8
RECURSIVE = YES
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
-# If the SOURCE_BROWSER tag is set to YES then a list of source files will
-# be generated. Documented entities will be cross-referenced with these sources.
-# Note: To get rid of all source code in the generated output, make sure also
-# VERBATIM_HEADERS is set to NO.
-
SOURCE_BROWSER = YES
-
-# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
-# doxygen to hide any special comment blocks from generated source code
-# fragments. Normal C and C++ comments will always remain visible.
-
STRIP_CODE_COMMENTS = NO
-
-# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
-# function all documented functions referencing it will be listed.
-
REFERENCED_BY_RELATION = YES
-
-# If the REFERENCES_RELATION tag is set to YES then for each documented
-# function all documented entities called/used by that function will be listed.
-
REFERENCES_RELATION = YES
#---------------------------------------------------------------------------
@@ -123,19 +72,7 @@ REFERENCES_RELATION = YES
#---------------------------------------------------------------------------
GENERATE_HTML = YES
-
-# The HTML_FOOTER tag can be used to specify a personal HTML footer for each
-# generated HTML page. If it is left blank doxygen will generate a standard
-# footer.
-
HTML_FOOTER = footer.inc.html
-
-# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
-# documentation will contain sections that can be hidden and shown after the
-# page has loaded. For this to work a browser that supports JavaScript and
-# DHTML is required (for instance Mozilla 1.0+, Firefox Netscape 6.0+,
-# Internet explorer 5.0+, Konqueror, or Safari).
-
HTML_DYNAMIC_SECTIONS = YES
GENERATE_DOCSET = NO
@@ -151,14 +88,6 @@ GENERATE_PERLMOD = NO
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
-# The PREDEFINED tag can be used to specify one or more macro names that
-# are defined before the preprocessor is started (similar to the -D option of
-# gcc). The argument of the tag is a list of macros of the form: name
-# or name=definition (no spaces). If the definition and the = are
-# omitted =1 is assumed. To prevent a macro definition from being
-# undefined via #undef or recursively expanded use the := operator
-# instead of the = operator.
-
PREDEFINED = DEBUG ZLIB PAM ZEROCONF CONN_MODULE __client_c__
# -eof-
diff --git a/doc/src/footer.inc.html b/doc/src/footer.inc.html
index a3a9552..ba05dcf 100644
--- a/doc/src/footer.inc.html
+++ b/doc/src/footer.inc.html
@@ -1,6 +1,6 @@
<hr class="footer">
-<p>
+<p style="text-align: center">
ngIRCd
<a href="http://ngircd.barton.de/">Homepage</a>,
<a href="http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git">GIT-Repository</a>,