docs: Generate grammar and option summaries from manpage.

[fwd] / addr.h

diff --git a/addr.h b/addr.h
index adc4cd1..5c30f46 100644 (file)
--- a/addr.h
+++ b/addr.h
@@ -1,6 +1,6 @@
 /* -*-c-*-
  *
- * $Id: addr.h,v 1.3 2003/11/25 14:08:23 mdw Exp $
+ * $Id: addr.h,v 1.5 2004/04/08 01:36:25 mdw Exp $
  *
  * Generic interface to network address handlers
  *
@@ -26,20 +26,6 @@
  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  */
 
-/*----- Revision history --------------------------------------------------* 
- *
- * $Log: addr.h,v $
- * Revision 1.3  2003/11/25 14:08:23  mdw
- * Debianization.  Socket target options.  Internet binding.
- *
- * Revision 1.2  1999/07/27 18:30:53  mdw
- * Various minor portability fixes.
- *
- * Revision 1.1  1999/07/26 23:34:26  mdw
- * Socket address type management.
- *
- */
-
 #ifndef ADDR_H
 #define ADDR_H
 
@@ -174,6 +160,20 @@ typedef struct addr_ops {
 
   int (*option)(scanner */*sc*/, addr_opts */*ao*/, unsigned /*type*/);
 
+  /* --- @confirm@ --- *
+   *
+   * Arguments:        @addr *a@ = pointer to an address structure
+   *           @unsigned type@ = kind of address this is
+   *           @addr_opts *ao@ = address options
+   *
+   * Returns:  ---
+   *
+   * Use:      Called during initialization when an address is fully
+   *           configured.
+   */
+
+  void (*confirm)(addr */*a*/, unsigned /*type*/, addr_opts */*ao*/);
+
   /* --- @freesrcopts@ --- *
    *
    * Arguments:        @addr_opts *ao@ = data block to remove