[vala] vapis: strip documentation comments

[Evan Nemerson <evann src gnome org>]

commit c171ab74fc9c16087fc2aa76f6fc9123ccfee4ac
Author: Florian Brosch <flo brosch gmail com>
Date:   Fri Dec 2 01:40:20 2011 +0100

    vapis: strip documentation comments

 vapi/gnutls.vapi    |   13 ----
 vapi/libgvc.vapi    |   24 --------
 vapi/libnl-2.0.vapi |   60 ++++++++++----------
 vapi/sdl-net.vapi   |  152 ---------------------------------------------------
 4 files changed, 30 insertions(+), 219 deletions(-)
---
diff --git a/vapi/gnutls.vapi b/vapi/gnutls.vapi
index a0bcf88..97a6977 100644
--- a/vapi/gnutls.vapi
+++ b/vapi/gnutls.vapi
@@ -1274,19 +1274,6 @@ namespace GnuTLS
 	[CCode (cheader_filename = "gnutls/openpgp.h")]
 	namespace OpenPGP
 	{
-		/**
-		* gnutls_openpgp_recv_key_func - Callback prototype to get OpenPGP keys
-		* @session: a TLS session
-		* @keyfpr: key fingerprint
-		* @keyfpr_length: length of key fingerprint
-		* @key: output key.
-		*
-		* A callback of this type is used to retrieve OpenPGP keys.  Only
-		* useful on the server, and will only be used if the peer send a key
-		* fingerprint instead of a full key.  See also
-		* gnutls_openpgp_set_recv_key_function().
-		*
-		*/
 		[CCode (has_target = false)]
 		public delegate int RecvKeyFunc (Session session, uint8[] keyfpr, out Datum key);
 
diff --git a/vapi/libgvc.vapi b/vapi/libgvc.vapi
index b5aabc5..c32a56a 100644
--- a/vapi/libgvc.vapi
+++ b/vapi/libgvc.vapi
@@ -24,24 +24,9 @@
 [CCode (cprefix = "", lower_case_cprefix = "", cheader_filename = "graphviz/gvc.h")]
 namespace Gvc {
 
-	/**
-	 * Low-level initialization function for the graphviz library, used only if
-	 * you need to explicitly control the sizes of graph, node and edge objects.
-	 *
-	 * Note: It's not necessary to call initlib() if you already called aginit()
-	 *       because aginit() makes a call to aginitlib() internally.
-	 */
 	[CCode (cname = "aginitlib", cheader_filename="gvc.h")]
 	public void initlib ( size_t graphinfo, size_t nodeinfo, size_t  edgeinfo);
 
-	/**
-	 * You must call aginit() before using the graphviz API. However, note that
-	 * both gvContext() and gvParseArgs() will call aginit() internally if necessary.
-	 * It's safe to call aginit() multiple times.
-	 *
-	 * For more information of Graphviz initialization, see documention at:
-	 * http://graphviz.org/pdf/libguide.pdf
-	 */
 	[CCode (cname = "aginit")]
 	public void init ();
 
@@ -140,7 +125,6 @@ namespace Gvc {
 		[CCode (cname = "agedge")]
 		public Edge create_edge (Node from, Node to);
 
-		/** Note: name set to "null" creates an anonymous subgraph. */
 		[CCode (cname = "agsubg")]
 		public unowned Graph create_subgraph ([CCode (type = "char*")] string? name);
 
@@ -159,7 +143,6 @@ namespace Gvc {
 		[CCode (cname = "agparent")]
 		public Graph get_parent_graph ();
 
-		/** Note: agclose() is also allowed for subgraphs and has the same effect as agdelsubg(). */
 		[CCode (cname = "agdelsubg")]
 		public int delete_subgraph (Graph subgraph);
 
@@ -189,13 +172,6 @@ namespace Gvc {
 
 	}
 
-	/**
-	 * Graphviz has this concept of "referenced counted strings" to save memory.
-	 * In addition, there is a special type of string in Graphviz called an "HTML string".
-	 * More information about graphviz "HTML strings" can be found at:
-	 * http://www.graphviz.org/doc/info/shapes.html#html
-	 * And also near the end of page 9 in:  http://graphviz.org/pdf/libguide.pdf
-	 */
 	[CCode (cname = "char", copy_function = "agdupstr_html", free_function = "agstrfree")]
 	public class HtmlString : string {
 		[CCode (cname = "agstrdup_html")]
diff --git a/vapi/libnl-2.0.vapi b/vapi/libnl-2.0.vapi
index 4d65849..0caf870 100644
--- a/vapi/libnl-2.0.vapi
+++ b/vapi/libnl-2.0.vapi
@@ -101,15 +101,15 @@ namespace Netlink {
 
     [CCode (cprefix = "NLA_", cname = "int", cheader_filename = "netlink/attr.h")]
     public enum AttributeType {
-        UNSPEC,     /**< Unspecified type, binary data chunk */
-        U8,         /**< 8 bit integer */
-        U16,        /**< 16 bit integer */
-        U32,        /**< 32 bit integer */
-        U64,        /**< 64 bit integer */
-        STRING,     /**< NUL terminated character string */
-        FLAG,       /**< Flag */
-        MSECS,      /**< Micro seconds (64bit) */
-        NESTED,     /**< Nested attributes */
+        UNSPEC,
+        U8,
+        U16,
+        U32,
+        U64,
+        STRING,
+        FLAG,
+        MSECS,
+        NESTED,
         TYPE_MAX
     }
 
@@ -153,31 +153,31 @@ namespace Netlink {
 
     [CCode (cname = "enum nl_cb_action", cprefix = "NL_", cheader_filename = "netlink/netlink.h")]
     public enum CallbackAction {
-        OK,         //   Proceed with whatever comes next.
-        SKIP,       //   Skip this message.
-        STOP,       //   Stop parsing altogether and discard remaining messages.
+        OK,
+        SKIP,
+        STOP,
     }
 
     [CCode (cname = "enum nl_cb_kind", cprefix = "NL_CB_", cheader_filename = "netlink/netlink.h")]
     public enum CallbackKind {
-        DEFAULT,    // 	 Default handlers (quiet).
-        VERBOSE,    // 	 Verbose default handlers (error messages printed).
-        DEBUG,      // 	 Debug handlers for debugging.
-        CUSTOM,     // 	 Customized handler specified by the user.
+        DEFAULT,
+        VERBOSE,
+        DEBUG,
+        CUSTOM,
     }
 
     [CCode (cname = "enum nl_cb_type", cprefix = "NL_CB_", cheader_filename = "netlink/netlink.h")]
     public enum CallbackType {
-        VALID,      // 	 Message is valid.
-        FINISH,     // 	 Last message in a series of multi part messages received.
-        OVERRUN,    // 	 Report received that data was lost.
-        SKIPPED,    // 	 Message wants to be skipped.
-        ACK,        // 	 Message is an acknowledge.
-        MSG_IN,     // 	 Called for every message received.
-        MSG_OUT,    // 	 Called for every message sent out except for nl_sendto().
-        INVALID,    // 	 Message is malformed and invalid.
-        SEQ_CHECK,  // 	 Called instead of internal sequence number checking.
-        SEND_ACK,   // 	 Sending of an acknowledge message has been requested.
+        VALID,
+        FINISH,
+        OVERRUN,
+        SKIPPED,
+        ACK,
+        MSG_IN,
+        MSG_OUT,
+        INVALID,
+        SEQ_CHECK,
+        SEND_ACK,
     }
 
     [Compact]
@@ -305,10 +305,10 @@ namespace Netlink {
 
     [CCode (cprefix = "NL_DUMP_", cname = "int", cheader_filename = "netlink/types.h")]
     public enum DumpType {
-        LINE,           /**< Dump object briefly on one line */
-        DETAILS,        /**< Dump all attributes but no statistics */
-        STATS,          /**< Dump all attributes including statistics */
-        ENV,            /**< Dump all attribtues as env variables */
+        LINE,
+        DETAILS,
+        STATS,
+        ENV,
     }
 
     [CCode (cname = "struct nl_dump_params", free_function = "", cheader_filename = "netlink/types.h")]
diff --git a/vapi/sdl-net.vapi b/vapi/sdl-net.vapi
index 51bfe70..b4a6d72 100644
--- a/vapi/sdl-net.vapi
+++ b/vapi/sdl-net.vapi
@@ -3,31 +3,21 @@ namespace SDLNet {
 	[CCode (cname="SDLNet_Linked_Version")]
 	public static SDL.Version linked();
 
-	/**
-	 * Initialize the network API 
-	 * SDL must be initialized before calls to functions in this library, 
-	 * because this library uses utility functions from the SDL library.
-	 */
 	[CCode (cname="SDLNet_Init")]
 	public static int init();
 
-	/** Cleanup the network API */
 	[CCode (cname="SDLNet_Quit")]
 	public static void quit();
 
-	/** Write a 16bit value to a network packet buffer */
 	[CCode (cname="SDLNet_Write16")]
 	public static void write16(uint16 value, void *area);
 
-	/** Write a 32bit value to a network packet buffer */
 	[CCode (cname="SDLNet_Write32")]
 	public static void write32(uint value, void *area);
 
-	/** Read a 16bit value from a network packet buffer */
 	[CCode (cname="SDLNet_Read16")]
 	public static uint16 read16(void *area);
 
-	/** Read a 32bit value from a network packet buffer */
 	[CCode (cname="SDLNet_Read32")]
 	public static uint read32(void *area);
 
@@ -45,23 +35,9 @@ namespace SDLNet {
 		[CCode (cname="INADDR_NONE")]
 		public const uint NONE;
 
-		/** 
-		 * Resolve a host name and port to an IP address in network form.
-		 * @return If the function succeeds, it will return 0.
-		 * If the host couldn't be resolved, the host portion of the returned
-		 * address will be INADDR_NONE, and the function will return -1.
-		 * If 'host' is NULL, the resolved host will be set to INADDR_ANY.
-		 */
 		[CCode (cname="SDLNet_ResolveHost")]
 		public static int from_host(out IPAddress address, string? host, uint16 port);
 
-		/**
-		 * Resolve an ip address to a host name in canonical form. 
-		 * Note that this function is not thread-safe.
-		 * @return If the ip couldn't be resolved, this function returns null,
-		 * otherwise a pointer to a static buffer containing the hostname
-		 * is returned.  
-		 */
 		[CCode (cname="SDLNet_ResolveIP")]
 		public unowned string? lookup();
 	}// IPAddress
@@ -76,11 +52,9 @@ namespace SDLNet {
 		public int status;
 		public IPAddress address;
 
-		/** Allocate a single UDP packet 'size' bytes long. */
 		[CCode (cname="SDLNet_AllocPacket")]
 		public UDPPacket(int size);
 
-		/** Resize a single UDP packet 'newsize' bytes long. */
 		[CCode (cname="SDLNet_ResizePacket")]
 		public int resize(int newsize);
 	}// UDPPacket
@@ -94,51 +68,18 @@ namespace SDLNet {
 	[CCode (cname="struct _TCPsocket", free_function="SDLNet_TCP_Close")]
 	[Compact]
 	public class TCPSocket: Socket {
-		/** 
-		 * Open a TCP network socket
-		 * If ip.host is INADDR_NONE or INADDR_ANY, this creates a local server
-		 * socket on the given port, otherwise a TCP connection to the remote
-		 * host and port is attempted. 
-		 * @param ip The address passed in should already be
-		 * swapped to network byte order (addresses returned from 
-		 * SDLNet_ResolveHost() are already in the correct form).
-		 * @return The newly created socket is returned, or null if there was an error.
-		 */
 		[CCode (cname="SDLNet_TCP_Open")]
 		public TCPSocket(IPAddress ip);
 
-		/**
-		 * Accept an incoming connection on the given server socket.
-		 * @return The newly created socket is returned, or null if there was an error.
-		 */
 		[CCode (cname="SDLNet_TCP_Accept")]
 		public TCPSocket? accept();
 
-		/**
-		 * Get the IP address of the remote system associated with the socket.
-		 * @return If the socket is a server socket, this function returns null.
-		 */
 		[CCode (cname="SDLNet_TCP_GetPeerAddress")]
 		public IPAddress? get_address();
 
-		/**
-		 * Send data over the non-server socket 'sock'
-		 * @param data The data to send
-		 * @return This function returns the actual amount of data sent.  If the return value
-		 * is less than the amount of data sent, then either the remote connection was
-		 * closed, or an unknown socket error occurred.
-		 */
 		[CCode (cname="SDLNet_TCP_Send")]
 		public int send(uchar[] data);
 
-		/**
-		 * Receive up to (the length of data)  bytes of data over the non-server socket 'sock',
-		 * and store them in the buffer pointed to by 'data'.
-		 * @param data The buffer to store received data
-		 * @return This function returns the actual amount of data received.  If the return
-		 * value is less than or equal to zero, then either the remote connection was
-		 * closed, or an unknown socket error occurred.
-		 */
 		[CCode (cname="SDLNet_TCP_Recv")]
 		public int receive(uchar[] data);
 	}// TCPSocket
@@ -146,104 +87,27 @@ namespace SDLNet {
 	[CCode (cname="struct _UDPsocket", free_function="SDLNet_UDP_Close")]
 	[Compact]
 	public class UDPSocket: Socket {
-		/**
-		 * Open a UDP network socket
-		 * @param port If 'port' is non-zero, the UDP socket is bound to a local port.
-		 * The 'port' should be given in native byte order, but is used
-		 * internally in network (big endian) byte order, in addresses, etc.
-		 * This allows other systems to send to this socket via a known port.
-		 */
 		[CCode (cname="SDLNet_UDP_Open")]
 		public UDPSocket(uint16 port);
 
-		/**
-		 * Bind the address 'address' to the requested channel on the UDP socket.
-		 * @param channel If the channel is -1, then the first unbound channel that has not yet
-		 * been bound to the maximum number of addresses will be bound with
-		 * the given address as it's primary address.
-		 * If the channel is already bound, this new address will be added to the
-		 * list of valid source addresses for packets arriving on the channel.
-		 * If the channel is not already bound, then the address becomes the primary
-		 * address, to which all outbound packets on the channel are sent.
-		 * @param address If the channel is -1, then the first unbound channel that has not yet
-		 * been bound to the maximum number of addresses will be bound with
-		 * the given address as it's primary address.
-		 * If the channel is already bound, this new address will be added to the
-		 * list of valid source addresses for packets arriving on the channel.
-		 * If the channel is not already bound, then the address becomes the primary
-		 * address, to which all outbound packets on the channel are sent.
-		 * @return This function returns the channel which was bound, or -1 on error.
-		 */
 		[CCode (cname="SDLNet_UDP_Bind")]
 		public int bind(int channel, IPAddress address);
 
-		/** Unbind all addresses from the given channel */
 		[CCode (cname="SDLNet_UDP_Unbind")]
 		public void unbind(int channel);
 
-		/**
-		 * Get the primary IP address of the remote system associated with the 
-		 * socket and channel.  
-		 * @return If the channel is -1, then the primary IP port
-		 * of the UDP socket is returned -- this is only meaningful for sockets
-		 * opened with a specific port.
-		 * If the channel is not bound and not -1, this function returns null
-		 */
 		[CCode (cname="SDLNet_UDP_GetPeerAddress")]
 		public IPAddress? get_address(int channel);
 
-		/**
-		 * Send a single packet to the specified channel.
-		 * NOTE:
-		 * The maximum size of the packet is limited by the MTU (Maximum Transfer Unit)
-		 * of the transport medium.  It can be as low as 250 bytes for some PPP links,
-		 * and as high as 1500 bytes for ethernet.
-		 * @param channel If the channel specified in the packet is -1, the packet will be sent to
-		 * the address in the 'src' member of the packet.
-		 * @param packet The packet will be updated with the status of the packet after it has
-		 * been sent.
-		 * @return This function returns 1 if the packet was sent, or 0 on error.
-		 */
 		[CCode (cname="SDLNet_UDP_Send")]
 		public int send(int channel, UDPPacket packet);
 
-		/**
-		 * Receive a single packet from the UDP socket.
-		 * @param packet The returned packet contains the source address and the channel it arrived
-		 * on.  If it did not arrive on a bound channel, the the channel will be set
-		 * to -1.
-		 * The channels are checked in highest to lowest order, so if an address is
-		 * bound to multiple channels, the highest channel with the source address
-		 * bound will be returned.
-		 * @return This function returns the number of packets read from the network, or -1
-		 * on error.  This function does not block, so can return 0 packets pending.
-		 */
 		[CCode (cname="SDLNet_UDP_Recv")]
 		public int receive(UDPPacket packet);
 
-		/**
-		 * Send a vector of packets to the the channels specified within the packet.
-		 * If the channel specified in the packet is -1, the packet will be sent to
-		 * the address in the 'src' member of the packet.
-		 * Each packet will be updated with the status of the packet after it has 
-		 * been sent, -1 if the packet send failed.
-		 * @param packets The packets to send
-		 * @return This function returns the number of packets sent.
-		 */
 		[CCode (cname="SDLNet_UDP_SendV")]
 		public int send_many(UDPPacket[] packets);
 
-		/**
-		 * Receive a vector of pending packets from the UDP socket.
-		 * @param packets The returned packets contain the source address and the channel they arrived
-		 * on.  If they did not arrive on a bound channel, the the channel will be set
-		 * to -1.
-		 * The channels are checked in highest to lowest order, so if an address is
-		 * bound to multiple channels, the highest channel with the source address
-		 * bound will be returned.
-		 * @return This function returns the number of packets read from the network, or -1
-		 * on error.  This function does not block, so can return 0 packets pending.
-		 */
 		[CCode (cname="SDLNet_UDP_RecvV")]
 		public int receive_many([CCode (array_length = false)] UDPPacket[] packets);
 	}// UDPSocket
@@ -251,31 +115,15 @@ namespace SDLNet {
 	[CCode (cname="struct _SDLNet_SocketSet", free_function="SDLNet_FreeSocketSet")]
 	[Compact]
 	public class SocketSet {
-		/**
-		 * Allocate a socket set
-		 * @param maxsockets This creates a socket set for up to 'maxsockets' sockets
-		 */
 		[CCode (cname="SDLNet_AllocSocketSet")]
 		public SocketSet(int maxsockets);
 
-		/** Add a socket to a set of sockets to be checked for available data */
 		[CCode (cname="SDLNet_AddSocket")]
 		public int add(Socket socket);
 
-		/** Remove a socket from a set of sockets to be checked for available data */
 		[CCode (cname="SDLNet_DelSocket")]
 		public int remove(Socket socket);
 
-		/**
-		 * This function checks to see if data is available for reading on the
-		 * given set of sockets.  
-		 * @param timeout If 'timeout' is 0, it performs a quick poll,
-		 * otherwise the function returns when either data is available for
-		 * reading, or the timeout in milliseconds has elapsed, which ever occurs
-		 * first.  
-		 * @return This function returns the number of sockets ready for reading, 
-		 * or -1 if there was an error with the select() system call.
-		 */
 		[CCode (cname="SDLNet_CheckSockets")]
 		public int has_data(uint timeout);
 	}// SocketSet