Fix validation errors when producing documentation using default build script

The awk script parses out the first instance of the DOCUMENTATION tag that it
finds within a file.  If a file did not previously have a DOCUMENTATION tag
but received one due to it having an AMI event, then the XML fragment
associated with the AMI event was erroneously placed in the resulting XML
file.  Without the python scripts, these XML fragments will not validate.

This patch adds DOCUMENTATION tags at the top of those files that did
not previously have them to prevent the awk script from pulling AMI event
documentation.

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@369910 65c4cc65-6c06-0410-ace0-fbb531ad65f3

diff --git a/channels/sig_analog.c b/channels/sig_analog.c
index e84bbc6..eef0436 100644 (file)
--- a/channels/sig_analog.c
+++ b/channels/sig_analog.c
@@ -46,6 +46,9 @@
 
 #include "sig_analog.h"
 
+/*** DOCUMENTATION
+ ***/
+
 /*! \note
  * Define if you want to check the hook state for an FXO (FXS signalled) interface
  * before dialing on it.  Certain FXO interfaces always think they're out of

diff --git a/channels/sig_pri.c b/channels/sig_pri.c
index 2489990..f6d7b08 100644 (file)
--- a/channels/sig_pri.c
+++ b/channels/sig_pri.c
@@ -56,6 +56,10 @@
 #error please update libpri
 #endif
 
+/*** DOCUMENTATION
+ ***/
+
+
 /* define this to send PRI user-user information elements */
 #undef SUPPORT_USERUSER
 

diff --git a/main/asterisk.c b/main/asterisk.c
index 0a801c1..08aaa57 100644 (file)
--- a/main/asterisk.c
+++ b/main/asterisk.c
@@ -154,6 +154,9 @@ int daemon(int, int);  /* defined in libresolv of all places */
 
 #include "../defaults.h"
 
+/*** DOCUMENTATION
+ ***/
+
 #ifndef AF_LOCAL
 #define AF_LOCAL AF_UNIX
 #define PF_LOCAL PF_UNIX

diff --git a/main/cdr.c b/main/cdr.c
index 295108d..053c86b 100644 (file)
--- a/main/cdr.c
+++ b/main/cdr.c
@@ -55,6 +55,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 #include "asterisk/stringfields.h"
 #include "asterisk/data.h"
 
+/*** DOCUMENTATION
+ ***/
+
 /*! Default AMA flag for billing records (CDR's) */
 int ast_default_amaflags = AST_CDR_DOCUMENTATION;
 char ast_default_accountcode[AST_MAX_ACCOUNT_CODE];

diff --git a/main/channel.c b/main/channel.c
index 6b1f306..9abd9e7 100644 (file)
--- a/main/channel.c
+++ b/main/channel.c
@@ -73,6 +73,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 #include "asterisk/data.h"
 #include "asterisk/channel_internal.h"
 
+/*** DOCUMENTATION
+ ***/
+
 #ifdef HAVE_EPOLL
 #include <sys/epoll.h>
 #endif

diff --git a/main/loader.c b/main/loader.c
index b952137..d715092 100644 (file)
--- a/main/loader.c
+++ b/main/loader.c
@@ -60,6 +60,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 #include "asterisk/md5.h"
 #include "asterisk/utils.h"
 
+/*** DOCUMENTATION
+ ***/
+
 #ifndef RTLD_NOW
 #define RTLD_NOW 0
 #endif

diff --git a/main/logger.c b/main/logger.c
index 6d6227b..515e344 100644 (file)
--- a/main/logger.c
+++ b/main/logger.c
@@ -69,6 +69,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 #  endif
 #endif
 
+/*** DOCUMENTATION
+ ***/
+
 static char dateformat[256] = "%b %e %T";              /* Original Asterisk Format */
 
 static char queue_log_name[256] = QUEUELOG;