Annotation of gpl/axl/ns/axl_ns_doc.h, revision 1.1

1.1     ! misho       1: /*
        !             2:  *  LibAxl:  Another XML library
        !             3:  *  Copyright (C) 2006 Advanced Software Production Line, S.L.
        !             4:  *
        !             5:  *  This program is free software; you can redistribute it and/or
        !             6:  *  modify it under the terms of the GNU Lesser General Public License
        !             7:  *  as published by the Free Software Foundation; either version 2.1 of
        !             8:  *  the License, or (at your option) any later version.
        !             9:  *
        !            10:  *  This program is distributed in the hope that it will be useful,
        !            11:  *  but WITHOUT ANY WARRANTY; without even the implied warranty of 
        !            12:  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the  
        !            13:  *  GNU Lesser General Public License for more details.
        !            14:  *
        !            15:  *  You should have received a copy of the GNU Lesser General Public
        !            16:  *  License along with this program; if not, write to the Free
        !            17:  *  Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
        !            18:  *  02111-1307 USA
        !            19:  *  
        !            20:  *  You may find a copy of the license under this software is released
        !            21:  *  at COPYING file. This is LGPL software: you are welcome to
        !            22:  *  develop proprietary applications using this library without any
        !            23:  *  royalty or fee but returning back any change, improvement or
        !            24:  *  addition in the form of source code, project image, documentation
        !            25:  *  patches, etc. 
        !            26:  *
        !            27:  *  For commercial support on build XML enabled solutions contact us:
        !            28:  *          
        !            29:  *      Postal address:
        !            30:  *         Advanced Software Production Line, S.L.
        !            31:  *         Edificio Alius A, Oficina 102,
        !            32:  *         C/ Antonio Suarez Nº 10,
        !            33:  *         Alcalá de Henares 28802 Madrid
        !            34:  *         Spain
        !            35:  *
        !            36:  *      Email address:
        !            37:  *         info@aspl.es - http://www.aspl.es/xml
        !            38:  */
        !            39: #ifndef __AXL_NS_DOC_H__
        !            40: #define __AXL_NS_DOC_H__
        !            41: 
        !            42: #include <axl_ns.h>
        !            43: 
        !            44: BEGIN_C_DECLS
        !            45: 
        !            46: /** 
        !            47:  * \addtogroup axl_ns_doc_module
        !            48:  * @{
        !            49:  */
        !            50: 
        !            51: axl_bool axl_ns_doc_validate      (axlDoc * doc, axlError ** error);
        !            52: 
        !            53: axl_bool axl_ns_doc_node_check    (axlNode    * node, 
        !            54:                                   const char * ns_prefix, 
        !            55:                                   const char * ns);
        !            56: 
        !            57: axl_bool axl_ns_doc_check_default (axlNode    * node, 
        !            58:                                   const char * ns);
        !            59: 
        !            60: /** 
        !            61:  * @brief Convenience macro that allows to call \ref
        !            62:  * axl_ns_node_find_called, providing a document, making the parent
        !            63:  * reference to use the root document node (with namespace support).
        !            64:  *
        !            65:  * See \ref axl_ns_node_find_called for more information.
        !            66:  * 
        !            67:  * @param doc The document where the node lookup will be produced.
        !            68:  *
        !            69:  * @param ns The namespace to use to find the the node using this
        !            70:  * rules.
        !            71:  * 
        !            72:  * @param name The child node name that is looked up.
        !            73:  * 
        !            74:  * @return A reference to the node found or NULL if it fails to find
        !            75:  * the node requested.
        !            76:  */
        !            77: #define axl_ns_doc_find_called(doc,ns,name) (axl_ns_node_find_called(axl_doc_get_root(doc),ns,name))
        !            78: 
        !            79: /**
        !            80:  * @}
        !            81:  */
        !            82: 
        !            83: END_C_DECLS
        !            84: 
        !            85: #endif
        !            86: 
        !            87: 

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>