Remove brackets from <methodname> tags

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@289061 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Michael Maclean 2009-10-01 18:20:40 +00:00
parent c664b7fa04
commit e5b2d6a62e
29 changed files with 62 additions and 62 deletions

View file

@ -34,7 +34,7 @@
<term><parameter>status</parameter></term>
<listitem>
<para>
A valid status code given by <function>cairo_status</function> or <methodname>CairoContext::status</methodname>()
A valid status code given by <function>cairo_status</function> or <methodname>CairoContext::status</methodname>
</para>
</listitem>
</varlistentry>

View file

@ -15,13 +15,13 @@
Context is the main object used when drawing with cairo. To draw with cairo, you create a
<classname>CairoContext</classname>, set the target <classname>CairoSurface</classname>,
and drawing options for the <classname>CairoContext</classname>, create shapes with functions .
like <methodname>CairoContext::moveTo</methodname>() and
<methodname>CairoContext::lineTo</methodname>(), and then draw shapes with
<methodname>CairoContext::stroke</methodname>() or <methodname>CairoContext::fill</methodname>().
like <methodname>CairoContext::moveTo</methodname> and
<methodname>CairoContext::lineTo</methodname>, and then draw shapes with
<methodname>CairoContext::stroke</methodname> or <methodname>CairoContext::fill</methodname>.
Contexts can be pushed to a stack via <methodname>CairoContext::save</methodname>().
Contexts can be pushed to a stack via <methodname>CairoContext::save</methodname>.
They may then safely be changed, without loosing the current state. Use
<methodname>CairoContext::restore</methodname>()
<methodname>CairoContext::restore</methodname>
to restore to the saved state.
</para>
</section>

View file

@ -23,8 +23,8 @@
</methodsynopsis>
<para>
Appends the <parameter>path</parameter> onto the current path.
The <parameter>path</parameter> may be either the return value from one of <methodname>CairoContext::copyPath</methodname>() or
<methodname>CairoContext::copyPathFlat</methodname>();
The <parameter>path</parameter> may be either the return value from one of <methodname>CairoContext::copyPath</methodname> or
<methodname>CairoContext::copyPathFlat</methodname>;
</para>
<para>
if <parameter>path</parameter> is not a valid <classname>CairoPath</classname> instance

View file

@ -39,8 +39,8 @@
If there is a current point, an initial line segment will be added to the path to connect the
current point to the beginning of the arc. If this initial line is undesired,
it can be avoided by calling <methodname>CairoContext::newSubPath</methodname>() or procedural
<function>cairo_new_sub_path</function> before calling <methodname>CairoContext::arc</methodname>()
it can be avoided by calling <methodname>CairoContext::newSubPath</methodname> or procedural
<function>cairo_new_sub_path</function> before calling <methodname>CairoContext::arc</methodname>
or <function>cairo_arc</function>.
Angles are measured in radians. An angle of 0.0 is in the direction of the positive X axis
@ -50,7 +50,7 @@
(To convert from degrees to radians, use degrees * (M_PI / 180.).)
This function gives the arc in the direction of increasing angles; see
<methodname>CairoContext::arcNegative</methodname>() or <function>cairo_arc_negative</function>
<methodname>CairoContext::arcNegative</methodname> or <function>cairo_arc_negative</function>
to get the arc in the direction of decreasing angles.
<!--

View file

@ -37,7 +37,7 @@
<parameter>angle1</parameter> it will be progressively decreased by 2*M_PI until it is less than
<parameter>angle1</parameter>.
See <methodname>CairoContext::arc</methodname>() or <function>cairo_arc</function> for more details.
See <methodname>CairoContext::arc</methodname> or <function>cairo_arc</function> for more details.
This function differs only in the direction of the arc between the two angles.
</para>

View file

@ -22,12 +22,12 @@
</methodsynopsis>
<para>
Establishes a new clip region by intersecting the current clip region with the current path as it
would be filled by <methodname>CairoContext::fill</methodname>() or <function>cairo_fill</function>
and according to the current fill rule (see <methodname>CairoContext::setFillRule</methodname>()
would be filled by <methodname>CairoContext::fill</methodname> or <function>cairo_fill</function>
and according to the current fill rule (see <methodname>CairoContext::setFillRule</methodname>
or <function>cairo_set_fill_rule</function>).
</para>
<para>
After <methodname>CairoContext::clip</methodname>() or <function>cairo_clip</function>,
After <methodname>CairoContext::clip</methodname> or <function>cairo_clip</function>,
the current path will be cleared from the cairo context.
</para>
<para>
@ -35,14 +35,14 @@
to the surface that are outside the current clip region.
</para>
<para>
Calling <methodname>CairoContext::clip</methodname>() or <function>cairo_clip</function>
Calling <methodname>CairoContext::clip</methodname> or <function>cairo_clip</function>
can only make the clip region smaller, never larger. But the current clip is part of the
graphics state, so a temporary restriction of the clip region can be achieved by calling
<methodname>CairoContext::clip</methodname>() or <function>cairo_clip</function> within a
<methodname>CairoContext::save</methodname>()/<methodname>CairoContext::restore</methodname>() or
<methodname>CairoContext::clip</methodname> or <function>cairo_clip</function> within a
<methodname>CairoContext::save</methodname>/<methodname>CairoContext::restore</methodname> or
<function>cairo_save</function>/<function>cairo_restore</function> pair.
The only other means of increasing the size of the clip region is
<methodname>CairoContext::resetClip</methodname>() or procedural <function>cairo_reset_clip</function>.
<methodname>CairoContext::resetClip</methodname> or procedural <function>cairo_reset_clip</function>.
</para>
</refsect1>

View file

@ -22,22 +22,22 @@
</methodsynopsis>
<para>
Establishes a new clip region by intersecting the current clip region with the current path as
it would be filled by <methodname>Context.fill()</methodname> and according to the current
FILL RULE (see <methodname>CairoContext::setFillRule</methodname>() or
it would be filled by <methodname>Context.fill</methodname> and according to the current
FILL RULE (see <methodname>CairoContext::setFillRule</methodname> or
<function>cairo_set_fill_rule</function>).
</para>
<para>
Unlike <methodname>CairoContext::clip</methodname>(), <methodname>CairoContext::clipPreserve</methodname>()
Unlike <methodname>CairoContext::clip</methodname>, <methodname>CairoContext::clipPreserve</methodname>
preserves the path within the Context.
The current clip region affects all drawing operations by effectively masking out any changes
to the surface that are outside the current clip region.
</para>
<para>
Calling <methodname>CairoContext::clipPreserve</methodname>() can only make the clip region smaller,
Calling <methodname>CairoContext::clipPreserve</methodname> can only make the clip region smaller,
never larger. But the current clip is part of the graphics state, so a temporary restriction of the clip
region can be achieved by calling <methodname>CairoContext::clipPreserve</methodname>() within a
<methodname>CairoContext::save</methodname>()/<methodname>CairoContext::restore</methodname>() pair.
The only other means of increasing the size of the clip region is <methodname>CairoContext::resetClip</methodname>().
region can be achieved by calling <methodname>CairoContext::clipPreserve</methodname> within a
<methodname>CairoContext::save</methodname>/<methodname>CairoContext::restore</methodname> pair.
The only other means of increasing the size of the clip region is <methodname>CairoContext::resetClip</methodname>.
</para>
&warn.undocumented.func;

View file

@ -22,19 +22,19 @@
</methodsynopsis>
<para>
Adds a line segment to the path from the current point to the beginning of the current sub-path,
(the most recent point passed to <methodname>CairoContext::moveTo</methodname>()),
(the most recent point passed to <methodname>CairoContext::moveTo</methodname>),
and closes this sub-path. After this call the current point will be at the joined endpoint
of the sub-path.
</para>
<para>
The behavior of close_path() is distinct from simply calling
<methodname>CairoContext::lineTo</methodname>() with the equivalent coordinate in the case of
<methodname>CairoContext::lineTo</methodname> with the equivalent coordinate in the case of
stroking. When a closed sub-path is stroked, there are no caps on the ends of the sub-path.
Instead, there is a line join connecting the final and initial segments of the sub-path.
</para>
<para>
If there is no current point before the call to <methodname>CairoContext::closePath</methodname>(),
If there is no current point before the call to <methodname>CairoContext::closePath</methodname>,
this function will have no effect.
</para>

View file

@ -47,7 +47,7 @@
&reftitle.examples;
<para>
<example>
<title><methodname>CairoContext::__construct</methodname>() example</title>
<title><methodname>CairoContext::__construct</methodname> example</title>
<programlisting role="php">
<![CDATA[
<?php

View file

@ -23,11 +23,11 @@
<para>
Emits the current page for backends that support multiple pages, but doesnt clear it, so,
the contents of the current page will be retained for the next page too.
Use <methodname>CairoContext::showPage</methodname>() if you want to get an empty page after the emission.
Use <methodname>CairoContext::showPage</methodname> if you want to get an empty page after the emission.
</para>
<para>
This is a convenience function that simply calls <methodname>CairoSurface::copyPage()</methodname>
This is a convenience function that simply calls <methodname>CairoSurface::copyPage</methodname>
on <classname>CairoContext</classname>s target.
</para>

View file

@ -47,7 +47,7 @@
Gets a flattened copy of the current path and returns it to the user as a <classname>CairoPath.</classname>
</para>
<para>
This function is like <methodname>CairoContext::copyPath</methodname>() except that any curves
This function is like <methodname>CairoContext::copyPath</methodname> except that any curves
in the path will be approximated with piecewise-linear approximations,
(accurate to within the current tolerance value). That is, the result is guaranteed to not
have any elements of type CAIRO_PATH_CURVE_TO which will instead be replaced by a series of

View file

@ -38,7 +38,7 @@
points. After this call the current point will be <parameter>x3</parameter>, <parameter>y3</parameter>.
</para>
<para>
If there is no current point before the call to <methodname>CairoContext::curveTo</methodname>()
If there is no current point before the call to <methodname>CairoContext::curveTo</methodname>
this function will behave as if preceded by a call to <methodname>CairoContext::moveTo</methodname>
(<parameter>x1</parameter>, <parameter>y1</parameter>).
</para>

View file

@ -25,7 +25,7 @@
</methodsynopsis>
<para>
Transform a distance vector from device space to user space. This function is similar to
<methodname>CairoContext::deviceToUser</methodname>() or <function>cairo_device_to_user</function>
<methodname>CairoContext::deviceToUser</methodname> or <function>cairo_device_to_user</function>
except that the translation components of the inverse Cairo Transformation Matrix will be
ignored when transforming (<parameter>x</parameter>,<parameter>y</parameter>).
</para>

View file

@ -23,7 +23,7 @@
<para>
A drawing operator that fills the current path according to the current
<classname>CairoFillRule</classname>, (each sub-path is implicitly closed before being filled).
After <methodname>CairoContext::fill</methodname>() or <function>cairo_fill</function>, the
After <methodname>CairoContext::fill</methodname> or <function>cairo_fill</function>, the
current path will be cleared from the <classname>CairoContext</classname>.
</para>

View file

@ -22,18 +22,18 @@
</methodsynopsis>
<para>
Computes a bounding box in user coordinates covering the area that would be affected,
(the “inked” area), by a <methodname>CairoContext::fill</methodname>() operation given the
(the “inked” area), by a <methodname>CairoContext::fill</methodname> operation given the
current path and fill parameters. If the current path is empty,
returns an empty rectangle (0,0,0,0). Surface dimensions and clipping are not taken into account.
</para>
<para>
Contrast with <methodname>CairoContext::pathExtents</methodname>(), which is similar, but returns
Contrast with <methodname>CairoContext::pathExtents</methodname>, which is similar, but returns
non-zero extents for some paths with no inked area, (such as a simple line segment).
</para>
<para>
Note that <methodname>CairoContext::fillExtents</methodname>() must necessarily do more work to
Note that <methodname>CairoContext::fillExtents</methodname> must necessarily do more work to
compute the precise inked areas in light of the fill rule, so
<methodname>CairoContext::pathExtents</methodname>() may be more desirable for sake of
<methodname>CairoContext::pathExtents</methodname> may be more desirable for sake of
performance if the non-inked path extents are desired.
</para>
</refsect1>

View file

@ -23,7 +23,7 @@
<para>
A drawing operator that fills the current path according to the current <classname>CairoFillRule</classname>,
(each sub-path is implicitly closed before being filled).
Unlike <methodname>CairoContext::fill</methodname>(), <methodname>CairoContext::fillPreserve</methodname>()
Unlike <methodname>CairoContext::fill</methodname>, <methodname>CairoContext::fillPreserve</methodname>
(Procedural <function>cairo_fill</function>, <function>cairo_fill_preserve</function>, respectively)
preserves the path within the Context.
</para>

View file

@ -22,7 +22,7 @@
</methodsynopsis>
<para>
Returns the current <classname>CairoAntialias</classname> mode, as set by
<methodname>CairoContext::setAntialias</methodname>().
<methodname>CairoContext::setAntialias</methodname>.
</para>
</refsect1>

View file

@ -13,7 +13,7 @@
&reftitle.intro;
<para>
A <classname>CairoFilter</classname> is used to indicate what filtering should be applied when reading pixel values
from patterns. See <methodname>CairoPattern::setSource</methodname>() or <function>cairo_pattern_set_source</function>
from patterns. See <methodname>CairoPattern::setSource</methodname> or <function>cairo_pattern_set_source</function>
for indicating the desired filter to be used with a particular pattern.
</para>
</section>

View file

@ -17,7 +17,7 @@
</para>
<para>
Note: This class can not be instantiated directly, it is created by
<methodname>CairoContext::getFontFace()</methodname> or <function>cairo_scaled_font_get_font_face</function>.
<methodname>CairoContext::getFontFace</methodname> or <function>cairo_scaled_font_get_font_face</function>.
</para>
</section>
<!-- }}} -->

View file

@ -36,7 +36,7 @@
&reftitle.examples;
<para>
<example>
<title><methodname>CairoFontFace::getType</methodname>() example</title>
<title><methodname>CairoFontFace::getType</methodname> example</title>
<programlisting role="php">
<![CDATA[
<?php

View file

@ -21,8 +21,8 @@
</para>
<para>
New features may be added to <classname>CairoFontOptions</classname> in the future. For this reason
<methodname>CairoFontOptions::copy</methodname>(), <methodname>CairoFontOptions::equal</methodname>(),
<methodname>CairoFontOptions::merge</methodname>(), <methodname>CairoFontOptions::hash</methodname>()
<methodname>CairoFontOptions::copy</methodname>, <methodname>CairoFontOptions::equal</methodname>,
<methodname>CairoFontOptions::merge</methodname>, <methodname>CairoFontOptions::hash</methodname>
(cairo_font_options_copy(), cairo_font_options_equal(), cairo_font_options_merge(), and cairo_font_options_hash()
in procedural way) should be used to copy, check for equality, merge, or compute a hash value of
<classname>CairoFontOptions</classname> objects.

View file

@ -18,9 +18,9 @@
</para>
<para>
The type of a CairoFontFace is determined by the how it is created, an example would be the
<methodname>CairoToyFontFace::__construct</methodname>().
<methodname>CairoToyFontFace::__construct</methodname>.
The <classname>CairoFontFace</classname> type can be queried with
<methodname>CairoFontFace::getType</methodname>() or <function>cairo_font_face_get_type</function>
<methodname>CairoFontFace::getType</methodname> or <function>cairo_font_face_get_type</function>
</para>
<para>
The various <classname>CairoFontFace</classname> functions can be used with a font face of any type.
@ -28,9 +28,9 @@
<para>
The type of a <classname>CairoScaledFont</classname> is determined by the type of the
<classname>CairoFontFace</classname> passed to
<methodname>CairoScaledFont::__construct</methodname>() or
<methodname>CairoScaledFont::__construct</methodname> or
<function>cairo_scaled_font_create</function>.
The scaled font type can be queried with <methodname>CairoScaledFont::getType</methodname>() or
The scaled font type can be queried with <methodname>CairoScaledFont::getType</methodname> or
<function>cairo_scaled_font_get_type</function>.
</para>
</section>

View file

@ -64,7 +64,7 @@
&reftitle.examples;
<para>
<example>
<title><methodname>CairoImageSurface::__construct</methodname>() example</title>
<title><methodname>CairoImageSurface::__construct</methodname> example</title>
<programlisting role="php">
<![CDATA[
<?php

View file

@ -49,7 +49,7 @@
&reftitle.examples;
<para>
<example>
<title><methodname>CairoImageSurface::createFromPng</methodname>() example</title>
<title><methodname>CairoImageSurface::createFromPng</methodname> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -73,7 +73,7 @@ $surface = CairoImageSurface::createFromPng('/path/to/image/file.png');
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>CairoImageSurface::__construct</methodname>()</member>
<member><methodname>CairoImageSurface::__construct</methodname></member>
</simplelist>
</para>
</refsect1>

View file

@ -35,7 +35,7 @@
&reftitle.examples;
<para>
<example>
<title><methodname>CairoImageSurface::getHeight</methodname>() example</title>
<title><methodname>CairoImageSurface::getHeight</methodname> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -62,7 +62,7 @@ int(50)
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>CairoImageSurface::getWidth</methodname>()</member>
<member><methodname>CairoImageSurface::getWidth</methodname></member>
</simplelist>
</para>
</refsect1>

View file

@ -35,7 +35,7 @@
&reftitle.examples;
<para>
<example>
<title><methodname>CairoImageSurface::getWidth</methodname>() example</title>
<title><methodname>CairoImageSurface::getWidth</methodname> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -62,7 +62,7 @@ int(80)
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>CairoImageSurface::getHeight</methodname>()</member>
<member><methodname>CairoImageSurface::getHeight</methodname></member>
</simplelist>
</para>
</refsect1>

View file

@ -14,10 +14,10 @@
<para>
<classname>CairoStatus</classname> is used to indicate errors that can occur when using Cairo.
In some cases it is returned directly by functions. but when using <classname>CairoContext</classname>,
the last error, if any, is stored in the object and can be retrieved with <methodname>CairoContext::status</methodname>()
the last error, if any, is stored in the object and can be retrieved with <methodname>CairoContext::status</methodname>
or <function>cairo_status</function>. New entries may be added in future versions.
</para>
<para>Use <methodname>Cairo::statusToString</methodname>() or <function>cairo_status_to_string</function> to get a
<para>Use <methodname>Cairo::statusToString</methodname> or <function>cairo_status_to_string</function> to get a
human-readable representation of an error message.
</para>
</section>

View file

@ -24,7 +24,7 @@
Returns a numerically indexed array of currently available
<classname>CairoSvgVersion</classname> constants. In order to retreive the
string values for each item, use
<methodname>CairoSvgSurface::versionToString</methodname>().
<methodname>CairoSvgSurface::versionToString</methodname>.
</para>
</refsect1>

View file

@ -13,7 +13,7 @@
&reftitle.intro;
<para>
The <classname>CairoToyFontFace</classname> class can be used instead of
<methodname>CairoContext::selectFontFace()</methodname> to create a toy font independently of a context.
<methodname>CairoContext::selectFontFace</methodname> to create a toy font independently of a context.
</para>
</section>
<!-- }}} -->