From d3119dfef5d4576acede79719177360b5dfa0927 Mon Sep 17 00:00:00 2001
From: "7u83@mail.ru" <7u83@mail.ru@noemail.net>
Date: Mon, 4 May 2015 05:27:35 +0000
Subject: [PATCH] New files.

FossilOrigin-Name: 2a7c230f1c4b05ec3ecd04e5b231f9fe290877c96c15ba08f65cd0f0e6b659ca
---
 src/capwap/cw_format_version.c | 85 ----------------------------------
 src/capwap/doc.dox             | 80 ++++++++++++++++++++++++++++++++
 2 files changed, 80 insertions(+), 85 deletions(-)
 delete mode 100644 src/capwap/cw_format_version.c
 create mode 100644 src/capwap/doc.dox

diff --git a/src/capwap/cw_format_version.c b/src/capwap/cw_format_version.c
deleted file mode 100644
index 63f991be..00000000
--- a/src/capwap/cw_format_version.c
+++ /dev/null
@@ -1,85 +0,0 @@
-/*
-    This file is part of libcapwap.
-
-    libcapwap is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    libcapwap is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with Foobar.  If not, see <http://www.gnu.org/licenses/>.
-
-*/
-
-#include <stdio.h>
-
-#include "lwapp.h"
-#include "cw_util.h"
-
-/**
- *@file
- *@brief Implementation of cw_sprintf_version 
- */
-
-
-/**
- * Converts a CAPWAP version string to readable format.
- * @param s target where the formated string will be stored
- * @param ver the CAPWAP version data
- * @param vendor vendor id 
- * @param def default string will be printed if version is NULL
- * @return the number bytes added to the output *s
- *
- * This function tries to determine if the bstr_t string version 
- * is human readable, and if not, it will put out a hexadecimal value
- * or a dot-seaprated list of number for version elements used
- * by Cisco.
- */
-int cw_format_version(char *s, bstr_t ver, uint32_t vendor, char * def)
-{
-	if (!ver)
-		return sprintf(s,"%s",def);
-
-
-	uint8_t * version = bstr_data(ver);
-	int len = bstr_len(ver);
-	
-
-
-	int rs=0;	
-	int i;
-
-
-	if ( cw_is_printable(version,len)  ){
-		if (len != 0 )
-			rs+=sprintf(s+rs,"%s",version);
-		else
-			rs+=sprintf(s+rs,"''");
-	}
-	else{
-		for (i=0; i<len && i<20; i++){
-			rs+=sprintf(s+rs,"%02X",version[i]);
-		}
-
-		int dot=0;
-
-		rs+=sprintf(s+rs," (");
-		for (i=0; i<len && i<20; i++){
-			if (dot) 
-				rs+=sprintf(s+rs,".");
-			dot=1;
-			rs+=sprintf(s+rs,"%d",version[i]);
-		}
-		rs+=sprintf(s+rs,")");
-	}
-
-	if (vendor) 
-		rs+=sprintf(s+rs,", Vendor Id: %d, %s",vendor, lw_vendor_id_to_str(vendor));
-	return rs;	
-}
-
diff --git a/src/capwap/doc.dox b/src/capwap/doc.dox
new file mode 100644
index 00000000..ace9a291
--- /dev/null
+++ b/src/capwap/doc.dox
@@ -0,0 +1,80 @@
+/*!
+ \mainpage LIBCAWAP Documentation
+
+ \section IBCAPWAPInstall Installing
+ To install libcapwap you need the following things:
+ A computer, a keyboard, some software and time.
+
+\section MsgHandling Extending CAPWAP
+Probably the easies way to explain, how to extend the CAPWAP, is to show an example.\n
+Here we go ...
+\subsection SimpleExample A Simple Example
+Imagine you whant to implement a new vendor specific message element called 
+"WTP LED Status and Color". In the real world this could be a message element, that 
+is  used by a WTP to indicate it's LED status, and sent by the AC to set the WTP's
+LED status.\n
+There might be a specification where the message element is idefined as follows:
+
+
+\code
+
+Vendor Specific Element - WTP LED Status and Color
+
+   0                   1                   
+   0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 
+   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+   |    Status     |   Color       |
+   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+
+Type: 17
+Length: 2
+ 
+Status: 
+   0=off
+   1=on
+   2=flashing
+
+Color:
+   0=blue
+   1=red
+   2=gren
+\endcode
+
+The first thing we have now to do, ist to define an item ID, that is interlnally 
+used by AC-Tube to store and find data associated with this message element. 
+This ID is simply a system-wide unique string constant.\n
+So let's create a file "mycapwap.c" and define the ID.
+
+\code 
+
+const char CW_MYITEM_WTP_LED_STATUS_AND_COLOR[]="wtp_led_status_and_color";
+
+\endcode
+
+The item ID is also used to identify message element data stored in a SQL 
+database or in json objects.\n
+Next we should provide some information about our item, which is done by
+creating an item definition, described by structure #cw_itemdef.\n
+Looking at the specification of our message element we see that the value
+is built of two bytes, which can be represented as word. There is a 
+pre-defined type MBAG_WORD which we will use.
+\code
+#include "capwap/mbag.h"
+const char CW_MYITEM_WTP_LED_STATUS_AND_COLOR[]="wtp_led_status_and_color";
+
+struct cw_itemdef_t myitemdefs[] = {
+	{CW_MYITEM_WTP_LED_STATUS,CW_ITEM_NONE,MBAG_WORD}
+};
+
+
+\endcode
+
+
+ \section ItemsElements Items, Elements, Messages ...
+
+
+ \subsection asd fdglksd
+ This is the text for the subsection.
+
+*/
+