added basic ssl support to ircu

[ircu2.10.12-pk.git] / doc / api / features.txt

diff --git a/doc/api/features.txt b/doc/api/features.txt
index a66e14409bfaff84465dd132a4fc8ab7f06a6c08..f7288ee8372e56b23f7c027d8c7fe3bbf5c8aae9 100644 (file)
--- a/doc/api/features.txt
+++ b/doc/api/features.txt
@@ -31,7 +31,9 @@ those features that are boolean types; and "STR" is for those features
 that take simple string values.  The values for these feature types
 are handled directly by the features subsystem, and can be examined
 from code with the feature_int(), feature_bool(), and feature_str()
-functions, described below.
+functions, described below.  These features have a notify callback,
+which is used to warn subsystems that use the values of particular
+features that the value has changed.
 
 Feature Flags
 
@@ -59,13 +61,13 @@ through the configuration file.
 Marking Features
 
 When the configuration file is read, there must be some way to
-determine if a particular F-line has been removed since the last time
-the configuration file was read.  The way this is done in the features
-subsystem is to have a "mark" for each feature.  Prior to reading the
-configuration file, all marks are cleared for all features (and all
-"unmark" call-backs are called).  As each F-line is encountered and
-processed, that feature's mark is set.  Finally, when the
-configuration file has been fully read, all remaining unmarked
+determine if a particular Feature entry has been removed since the
+last time the configuration file was read.  The way this is done in
+the features subsystem is to have a "mark" for each feature.  Prior to
+reading the configuration file, all marks are cleared for all features
+(and all "unmark" call-backs are called).  As each Feature entry is
+encountered and processed, that feature's mark is set.  Finally, when
+the configuration file has been fully read, all remaining unmarked
 features are reset to their default values (and all "mark" call-backs
 are called).
 
@@ -146,8 +148,8 @@ values for all features correctly.
 <function>
 void feature_report(struct Client* to);
 
-Reports all F-lines to a user using RPL_STATSFLINE, except those which
-the user is not permitted to see due to flag settings.
+Reports all Feature entries to a user using RPL_STATSFLINE, except
+those which the user is not permitted to see due to flag settings.
 </function>
 
 <function>
@@ -188,9 +190,9 @@ functions implementing the named call-back.
 #define F_I(type, flags, v_int, notify)
 
 To define integer features, use the F_I() macro.  The _type_ and
-_flags_ parameters are as for F_N(), and the _v_int_ macro specifies
-the default value of the feature.  The _notify_ parameter, if
-non-zero, will be called whenever the value of the feature changes.
+_flags_ parameters are as for F_N(), and the _v_int_ parameter
+specifies the default value of the feature.  The _notify_ parameter,
+if non-zero, will be called whenever the value of the feature changes.
 </macro>
 
 <macro>
@@ -219,6 +221,8 @@ Kev <klmitch@mit.edu>
 </authors>
 
 <changelog>
+[2001-06-13 Kev] Mention notify with the other callbacks
+
 [2001-01-02 Kev] Add documentation for new flags and for the notify
 mechanism