Req #47651 [Opn->Csd]: New format/theme to create funcindex.xml and friends
| From: | philip@php.net | Date: | Sat, 02 Jul 2011 04:52:22 +0000 |
| Subject: | Req #47651 [Opn->Csd]: New format/theme to create funcindex.xml and friends | ||
| References: | 1 | Groups: | php.doc.bugs |
| Request: | Send a blank email to doc-bugs+get-6796@lists.php.net to get a copy of this message | ||
Edit report at https://bugs.php.net/bug.php?id=47651&edit=1
ID: 47651
Updated by: philip@php.net
Reported by: philip@php.net
Summary: New format/theme to create funcindex.xml and friends
-Status: Open
+Status: Closed
Type: Feature/Change Request
Package: Doc Build problem
Operating System: All
PHP Version: Irrelevant
-Assigned To:
+Assigned To: philip
Block user comment: N
Private report: N
New Comment:
PhD_IDE solves this, and much much more. Thank Moacir for that!
Previous Comments:
------------------------------------------------------------------------
[2011-06-06 05:41:32] philip@php.net
Automatic comment from SVN on behalf of philip
Revision: http://svn.php.net/viewvc/?view=revision&revision=311858
Log: Updated the generated function text files using PhD_IDE. Deals with PHP bug #47651 and PHP bug
#52079. Kept BC where possible, but removed cruft from when these were generated by scanning
php-src. Adds many functions, and is the lists are alphabetical.
------------------------------------------------------------------------
[2009-05-01 23:08:28] philip@php.net
Here's a proof of concept structure from a documented function:
http://wiki.php.net/doc/skeletons/ide-function
Included are various thoughts, concerns, and points of discussion.
------------------------------------------------------------------------
[2009-03-29 23:19:24] philip@php.net
This feature should expand what we do currently, in order to be more
friendly to the IDE community.
TODO:
- Discuss this topic with the IDE community and determine
what they want
- Have as much information as possible
- Design the XML Syntax for these files
- Expand the idea for variables, types, constants, expressions, ...
- Work for functions that are both Procedural and OO
--- Like MySQLi
- Include example scripts for parsing these generated files
- Have one script available that converts it to SQLite
- Update these weekly and list them on the doc server
- Inform the IDE community of what we've done and will do
I've started discussing this with the IDE community.
------------------------------------------------------------------------
[2009-03-13 17:10:48] philip@php.net
Description:
------------
In phpdoc/ we have [had] the following:
- funcindex.xml
- funclist.txt
- funcsummary.txt
- quickref.txt
This is a request for PhD to build these.
Currently much of this information still comes directly from php-src,
and it'd be nice to simply build them from the documentation sources
instead. Building them from php-src is problematic, and besides our
scripts to do so are unmaintained and essentially broken.
And while this is done let's leave them out of CVS and host on either
the mirrors or doc.php.net.
Note: A related and additional option is to create an ini setting for
PhD to create funcindex.xml and use it in the build.
Note: Several scripts exist in scripts/ but likely they won't offer
much help as they simply scour php-src.
------------------------------------------------------------------------
--
Edit this bug report at https://bugs.php.net/bug.php?id=47651&edit=1