Bug #51667 [Asn->Csd]: improve consistency of rendering methodsynopsis and fieldsynopsis
| From: | bjori@php.net | Date: | Fri, 06 Apr 2012 17:27:55 +0000 |
| Subject: | Bug #51667 [Asn->Csd]: improve consistency of rendering methodsynopsis and fieldsynopsis | ||
| References: | 1 | Groups: | php.doc.bugs |
| Request: | Send a blank email to doc-bugs+get-8195@lists.php.net to get a copy of this message | ||
Edit report at https://bugs.php.net/bug.php?id=51667&edit=1
ID: 51667
Updated by: bjori@php.net
Reported by: danielc@php.net
Summary: improve consistency of rendering methodsynopsis and
fieldsynopsis
-Status: Assigned
+Status: Closed
Type: Bug
Package: Doc Build problem
PHP Version: Irrelevant
Assigned To: bjori
Block user comment: N
Private report: N
New Comment:
I'm fairly certain all issues here are fixed in the current versions.
Previous Comments:
------------------------------------------------------------------------
[2010-07-03 02:35:37] bjori@php.net
These are way to many issues in one report.
Specific example page, or the current output would also simplify this.
The <ooclass><classname> stuff is fixed, haven't looked at the fieldsynopsis
things yet.
------------------------------------------------------------------------
[2010-07-03 02:34:27] bjori@php.net
Automatic comment from SVN on behalf of bjori
Revision: http://svn.php.net/viewvc/?view=revision&revision=300959
Log: Fixed bug#51667 (improve consistency of rendering methodsynopsis and fieldsynopsis)
# Well, part#2 of it, part#1 and part#3 still left
------------------------------------------------------------------------
[2010-05-14 17:58:08] danielc@php.net
Sorry to use this bug report as a way of working through this issue... It seems like a good idea to
have properties marked up the same way we mark up methods -- put the class name in the method/field
element. This is better because it is consistent and shorter.
So the changes should also allow the following markup to produce the same HTML output as discussed
above.
DOCBOOK FOR OBJECT
------------------
<fieldsynopsis>
<modifier>public</modifier>
<type>int</type>
<varname>$foo->bar</varname>
</fieldsynopsis>
DOCBOOK FOR STATIC
------------------
<fieldsynopsis>
<modifier>public</modifier>
<modifier>static</modifier>
<type>int</type>
<varname>foo::$bar</varname>
</fieldsynopsis>
------------------------------------------------------------------------
[2010-05-12 03:20:08] danielc@php.net
Some OOP methodsynopsis in our existing DocBook sources are marked up inside classsynopsis, even
though the standard is to just have them on their own. So, while you're doing the
fieldsynopsis changes, it seems like a good idea to also adjust the rendering engine produce the
same HTML either way.
DOCBOOK WITH CLASSYNOPSIS
-------------------------
<classsynopsis>
<ooclass><classname>XMLWriter</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>openURI</methodname>
<methodparam><type>string</type><parameter>uri</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
STANDARD DOCBOOK
----------------
<methodsynopsis>
<type>bool</type><methodname>XMLWriter::openURI</methodname>
<methodparam><type>string</type><parameter>uri</parameter></methodparam>
</methodsynopsis>
SHOULD BOTH PRODUCE THE FOLLOWING HTML
--------------------------------------
<div class="methodsynopsis dc-description">
<span class="methodname"><b>XMLWriter::openURI</b></span>()
</div>
------------------------------------------------------------------------
[2010-04-26 18:06:17] danielc@php.net
The following patch has been added/updated:
Patch Name: fieldsynopsis-site.css
Revision: 1272297977
URL: http://bugs.php.net/patch-display.php?bug=51667&patch=fieldsynopsis-site.css&revision=1272297977
------------------------------------------------------------------------
The remainder of the comments for this report are too long. To view
the rest of the comments, please view the bug report online at
https://bugs.php.net/bug.php?id=51667
--
Edit this bug report at https://bugs.php.net/bug.php?id=51667&edit=1