php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login

go to bug id or search bugs for

Request #47651 New format/theme to create funcindex.xml and friends
Submitted: 2009-03-13 17:10 UTC Modified: 2011-07-02 00:52 UTC
From: philip@php.net Assigned: philip (profile)
Status: Closed Package: Doc Build problem
PHP Version: Irrelevant OS: All
Private report: No CVE-ID: None
View Developer Edit
 [2009-03-13 17:10 UTC] 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.

Patches

Pull Requests

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2009-03-29 23:19 UTC] 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-05-01 23:08 UTC] 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.
 [2010-03-12 16:19 UTC] moacir@php.net
-Type: Bug +Type: Feature/Change Request
 [2011-06-06 05:41 UTC] 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.
 [2011-07-02 00:52 UTC] philip@php.net
-Status: Open +Status: Closed -Assigned To: +Assigned To: philip
 [2011-07-02 00:52 UTC] philip@php.net 
PhD_IDE solves this, and much much more. Thank Moacir for that!
 
PHP Copyright © 2001-2024 The PHP Group
All rights reserved. 		Last updated: Wed Dec 04 19:01:32 2024 UTC