1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project 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; only version 2 of the License, dated June 1991.
-
- This program 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 this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="xpf_create_comment">
<refmeta>
<refentrytitle>create-comment</refentrytitle>
<refmiscinfo>XPATH</refmiscinfo>
</refmeta>
<refnamediv>
<refname>create-comment</refname>
<refpurpose>Creates a "comment" XML tree entity.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="xpf_syn_create_comment">
<funcprototype id="xpf_proto_create_comment">
<funcdef>entity <function>create-comment</function></funcdef>
<paramdef><parameter>comment-text</parameter> string</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="xpf_desc_create_comment"><title>Description</title>
<para>
This is an internal XQUERY function and you will probably never need to
call it explicitly. It is not a part of library of standard XQUERY 1.0
functions.
</para>
<para>
This function creates an XML entity of sort "comment"
that contains given text.
</para>
</refsect1>
<refsect1 id="xpf_params_create_comment"><title>Parameters</title>
<refsect2><title>comment-text</title>
<para>The text content of the comment</para></refsect2>
</refsect1>
<refsect1 id="xpf_ret_create_comment"><title>Return Types</title><para>XML tree entity</para></refsect1>
<refsect1 id="xpf_seealso_create_comment"><title>See Also</title>
<para><link linkend="xpf_create_attribute">create-attribute()</link></para>
<para><link linkend="xpf_create_element">create-element()</link></para>
<para><link linkend="xpf_create_pi">create-pi()</link></para>
</refsect1>
</refentry>
|