blob: 4667480028c8b3395085f28b7abe5a31760cf896 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
<head>
<title>Options Window: PHP: Custom Annotation Dialog Box</title>
<link rel="stylesheet" href="ide.css" title="Oracle BLAFDoc" type="text/css"/>
</head>
<body>
<p><a id="org.netbeans.modules.php.project.annotations.UserAnnotationPanel" name="org.netbeans.modules.php.project.annotations.UserAnnotationPanel"></a></p>
<div id="NBCSH3700"><!-- infolevel="all" infotype="General" --><a id="sthref499" name="sthref499"></a>
<h1>Options Window: PHP: Custom Annotation Dialog Box</h1>
<a name="BEGIN" id="BEGIN"></a>
<p>Use this panel to add or edit a custom PHP annotation.</p>
<table summary="User interface elements and descriptions" dir="ltr" border="1" width="100%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0">
<col width="24%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t35">Element</th>
<th align="left" valign="bottom" id="r1c2-t35">Description</th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t35" headers="r1c1-t35">
<p>Name</p>
</td>
<td align="left" headers="r2c1-t35 r1c2-t35">Name of the custom annotation.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t35" headers="r1c1-t35">
<p>For</p>
</td>
<td align="left" headers="r3c1-t35 r1c2-t35">The context associated with the annotation. Choose one from the following:
<ul>
<li>function</li>
<li>class/interface (type)</li>
<li>method</li>
<li>field</li>
</ul>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t35" headers="r1c1-t35">
<p>Template</p>
</td>
<td align="left" headers="r4c1-t35 r1c2-t35">The template for the annotation. By default, the field contains a sample annotation template that you can edit. The template for the annotation uses the same syntax as code templates.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r5c1-t35" headers="r1c1-t35">
<p>Documentation</p>
</td>
<td align="left" headers="r5c1-t35 r1c2-t35">The HTML documentation for the annotation. By default, the Source tab contains sample annotation documentation that you can edit. The Preview tab renders the HTML that is in the Source tab, displaying how the documentation appears when a user invokes code completion and selects this annotation.</td>
</tr>
</tbody>
</table>
<br />
<!-- -->
<a id="NBCSH3705" name="NBCSH3705"></a>
<hr><p><b>Related Topics</b></p>
<p><i>Developing Applications with NetBeans IDE</i>,
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer">
<param name="content" value="http://www.oracle.com/pls/topic/lookup?ctx=nb8200&id=NBDAG1534">
<param name="text" value="<html><u>&quot;About Developing PHP Applications&quot;</u></html>">
<param name="textFontSize" value="medium">
<param name="textColor" value="blue">
</object>
</p>
<!-- -->
<!-- Start Footer -->
<table summary="" cellspacing="0" cellpadding="0" width="100%">
<tr>
<td align="left" width="86%"><a href="legal_notice.htm">
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements; and to You under the Apache License, Version 2.0.</a>
</td>
</tr>
</table>
<!-- -->
</body>
</html>