php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login
Doc Bug #54220 DOM C14N documentation missing
Submitted: 2011-03-11 03:31 UTC Modified: 2011-12-07 04:43 UTC
Votes:4
Avg. Score:4.5 ± 0.5
Reproduced:4 of 4 (100.0%)
Same Version:1 (25.0%)
Same OS:1 (25.0%)
From: olamedia at gmail dot com Assigned: frozenfire (profile)
Status: Closed Package: Documentation problem
PHP Version: Irrelevant OS:
Private report: No CVE-ID: None
 [2011-03-11 03:31 UTC] olamedia at gmail dot com
Description:
------------
DOM C14N (method) documentation missing
This method can have two or more arguments, but I can't found information about 
it.


Patches

Add a Patch

Pull Requests

Add a Pull Request

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2011-03-11 03:33 UTC] olamedia at gmail dot com
From Netbeans IDE:
C14N($exclusive[, $with_commentsarray[, $xpath[, $ns_prefixes]]])
 [2011-03-11 11:21 UTC] rquadling@php.net
Both the DOMNode::C14N() and DOMNode::C14NFile() methods are missing.


[11/03/2011 10:21:03] [D:\BuildPHP\php53dev\vc9\x86\PHP_5_3] [] >php --rf DOMNode::C14N
Method [ <internal:dom> public method C14N ] {

  - Parameters [4] {
    Parameter #0 [ <optional> $exclusive ]
    Parameter #1 [ <optional> $with_comments ]
    Parameter #2 [ <optional> array or NULL $xpath ]
    Parameter #3 [ <optional> array or NULL $ns_prefixes ]
  }
}


[11/03/2011 10:21:18] [D:\BuildPHP\php53dev\vc9\x86\PHP_5_3] [] >php --rf DOMNode::C14NFile
Method [ <internal:dom> public method C14NFile ] {

  - Parameters [5] {
    Parameter #0 [ <required> $uri ]
    Parameter #1 [ <optional> $exclusive ]
    Parameter #2 [ <optional> $with_comments ]
    Parameter #3 [ <optional> array or NULL $xpath ]
    Parameter #4 [ <optional> array or NULL $ns_prefixes ]
  }
}
 [2011-05-02 22:56 UTC] philip@php.net
For the curious, here's how to generate a documentation a skeleton for these:

$ cd svn/doc-en
$ php doc-base/scripts/docgen/docgen.php --class DOMNode --method C14N
$ php doc-base/scripts/docgen/docgen.php --class DOMNode --method C14NFile
$ cd output/domnode
$ vim c14n.xml (make various edits, like for the return type/value)

Oh, and copy it to your checkout and commit:

$ cd ../..
$ cp output/domnode/c14n.xml en/reference/dom/domnode/
$ svn add en/reference/dom/domnode/c14n.xml
$ svn commit en/reference/dom/domnode/c14n.xml -m "Initial commit"

Normally " docgen.php --copy" could be used, but it appears broken when copying individual functions... :p
 [2011-12-07 04:42 UTC] frozenfire@php.net
Automatic comment from SVN on behalf of frozenfire
Revision: http://svn.php.net/viewvc/?view=revision&amp;revision=320554
Log: Documented C14N and C14NFile methods of DOMNode. Closes bug #54220.
 [2011-12-07 04:43 UTC] frozenfire@php.net
This bug has been fixed in the documentation's XML sources. Since the
online and downloadable versions of the documentation need some time
to get updated, we would like to ask you to be a bit patient.

Thank you for the report, and for helping us make our documentation better.


 [2011-12-07 04:43 UTC] frozenfire@php.net
-Status: Open +Status: Closed -Assigned To: +Assigned To: frozenfire
 
PHP Copyright © 2001-2024 The PHP Group
All rights reserved.
Last updated: Sun Apr 28 17:01:29 2024 UTC