Skip to content

Commit 1f3a562

Browse files
jonasjonasjonasjonas
committed
enhanced documentation
1 parent 2e6dbff commit 1f3a562

24 files changed

+69
-42
lines changed

‎documentation/Doxyfile

+2-2
Original file line numberDiff line numberDiff line change
@@ -1010,7 +1010,7 @@ VERBATIM_HEADERS = YES
10101010
# classes, structs, unions or interfaces.
10111011
# The default value is: YES.
10121012

1013-
ALPHABETICAL_INDEX = YES
1013+
ALPHABETICAL_INDEX = NO
10141014

10151015
# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
10161016
# which the alphabetical index list will be split.
@@ -2096,7 +2096,7 @@ DOT_NUM_THREADS = 0
20962096
# The default value is: Helvetica.
20972097
# This tag requires that the tag HAVE_DOT is set to YES.
20982098

2099-
DOT_FONTNAME =
2099+
DOT_FONTNAME =
21002100

21012101
# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
21022102
# dot graphs.

‎documentation/Makefile

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ RM = rm -rf
33
BACKCOLOR = backcolor_brightblue
44

55
doc: depage-docu examples/main-*.html
6-
cd ./depage-docu/ ; git pull origin master || true
6+
#cd ./depage-docu/ ; git pull origin master || true
77
doxygen Doxyfile
88
cp -r depage-docu/www/lib html/
9-
sed -i".bak" "s/<body/<body class=\\\"home\\\"/" html/index.html
10-
sed -i".bak" "s/div id=\\\"backcolor_\\\"/div id=\\\"${BACKCOLOR}\\\"/" html/*.html
9+
sed -i".bak" "s/<body class=\\\"\\\"/<body class=\\\"home\\\"/" html/index.html
10+
#sed -i".bak" "s/div id=\\\"backcolor_\\\"/div id=\\\"${BACKCOLOR}\\\"/" html/*.html
1111
rm html/*.bak
1212

1313
examples/main-*.html: ../README.md

‎elements/address.php

+1-2
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@
3333
3434
// Display the form.
3535
echo ($form);
36-
?>
37-
* @endcode
36+
@endcode
3837
**/
3938
class address extends fieldset
4039
{

‎elements/boolean.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
4141
// Display the form.
4242
echo ($form);
43-
?> @endcode
43+
@endcode
4444
**/
4545
class boolean extends abstracts\input
4646
{

‎elements/country.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
3434
// Display the form.
3535
echo ($form);
36-
?> @endcode
36+
@endcode
3737
**/
3838
class country extends single
3939
{

‎elements/creditcard.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
4040
// Display the form.
4141
echo ($form);
42-
?> @endcode
42+
@endcode
4343
**/
4444
class creditcard extends fieldset
4545
{

‎elements/email.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
3232
// Display the form.
3333
echo ($form);
34-
?> @endcode
34+
@endcode
3535
**/
3636
class email extends text
3737
{

‎elements/fieldset.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
4444
// Display the form.
4545
echo ($form);
46-
?> @endcode
46+
@endcode
4747
**/
4848

4949
class fieldset extends abstracts\container

‎elements/hidden.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
3131
// Display the form.
3232
echo ($form);
33-
?> @endcode
33+
@endcode
3434
**/
3535
class hidden extends text
3636
{

‎elements/html.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
2929
// Display the form.
3030
echo ($form);
31-
?> @endcode
31+
@endcode
3232
**/
3333
class html
3434
{

‎elements/multiple.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
5050
// Display the form.
5151
echo ($form);
52-
?> @endcode
52+
@endcode
5353
**/
5454
class multiple extends abstracts\input
5555
{

‎elements/number.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
3939
// Display the form.
4040
echo ($form);
41-
?> @endcode
41+
@endcode
4242
**/
4343
class number extends text
4444
{

‎elements/password.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
3232
// Display the form.
3333
echo ($form);
34-
?> @endcode
34+
@endcode
3535
**/
3636
class password extends text
3737
{

‎elements/placeholder.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
2929
// Display the form.
3030
echo ($form);
31-
?> @endcode
31+
@endcode
3232
**/
3333
class placeholder extends abstracts\input
3434
{

‎elements/placeholdermultiple.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
// add a hidden field
2222
$form->addPlaceholderMutliple('nonce');
2323
24-
?> @endcode
24+
@endcode
2525
**/
2626
class placeholdermultiple extends placeholder
2727
{

‎elements/range.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
3535
// Display the form.
3636
echo ($form);
37-
?> @endcode
37+
@endcode
3838
**/
3939
class range extends number
4040
{

‎elements/richtext.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
3232
// Display the form.
3333
echo ($form);
34-
?> @endcode
34+
@endcode
3535
**/
3636
class richtext extends textarea
3737
{

‎elements/single.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
5050
// Display the form.
5151
echo ($form);
52-
?> @endcode
52+
@endcode
5353
**/
5454
class single extends abstracts\input
5555
{

‎elements/state.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
3030
// Display the form.
3131
echo ($form);
32-
?> @endcode
32+
@endcode
3333
**/
3434
class state extends single
3535
{

‎elements/tel.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
3232
// Display the form.
3333
echo ($form);
34-
?> @endcode
34+
@endcode
3535
**/
3636
class tel extends text
3737
{

‎elements/text.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
3333
// Display the form.
3434
echo ($form);
35-
?> @endcode
35+
@endcode
3636
**/
3737
class text extends abstracts\input
3838
{

‎elements/textarea.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
2929
// Display the form.
3030
echo ($form);
31-
?> @endcode
31+
@endcode
3232
**/
3333
class textarea extends text
3434
{

‎elements/url.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
3131
// Display the form.
3232
echo ($form);
33-
?> @endcode
33+
@endcode
3434
**/
3535
class url extends text
3636
{

‎htmlform.php

+43-15
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
* modern browser functionality with maximum client coverage.
4343
*
4444
* Comfort
45+
* -------
4546
* - We abstract browser specifics from HTML-forms to provide a clean interface
4647
* to web developers. All configuration is located in one place.
4748
*
@@ -51,49 +52,51 @@
5152
* with JavaScript (client-side) or PHP (server-side).
5253
*
5354
* HTML5
55+
* -----
5456
* - We follow the HTML5 spec where it's sensible. The only clash so far is
5557
* @link depage::htmlform::elements::multiple::htmlInputAttributes checkbox
5658
* validation @endlink .
5759
* - We aim to provide as much HTML5 functionality as possible.
5860
*
5961
* Customization
62+
* -------------
6063
* - Input-elements can be easily modified by overriding the included
6164
* element-classes.
6265
* - New element-classes are automatically integrated by the autoloader. (They
6366
* can be instantiated with @link depage::htmlform::abstracts::container::__call
6467
* add @endlink (runtime generated methods))
6568
*
66-
* @section prerequisites Developer Prerequisites
67-
*
69+
* Developer Prerequisites
70+
* -----------------------
6871
* - PHP 5.3
6972
* - PHPUnit 3.5 (to run included unit tests)
7073
* - Doxygen 1.7.2 (to generate documentation)
7174
*
72-
* @section style Coding style
73-
*
75+
* Coding style
76+
* ------------
7477
* Generally, follow PSR-0, PSR-1, PSR-2 coding standard (http://www.php-fig.org)
7578
*
76-
* @section Deployment
77-
*
79+
* Deployment
80+
* ----------
7881
* To generate a gzipped release of the library (includes examples):
7982
*
80-
* <pre>$ make release</pre>
83+
* $ make release
8184
*
8285
* To generate a gzipped release with the essentials for working environments:
8386
*
84-
* <pre>$ make min</pre>
85-
*
86-
* @section Tests
87+
* $ make min
8788
*
89+
* Tests
90+
* -----
8891
* To run the unit tests:
8992
*
90-
* <pre>$ make test</pre>
91-
*
92-
* @section Documentation
93+
* $ make test
9394
*
95+
* Documentation
96+
* -------------
9497
* To generate documentation:
9598
*
96-
* <pre>$ make doc</pre>
99+
* $ make doc
97100
**/
98101
// }}}
99102

@@ -116,6 +119,31 @@
116119
* but also to also to @link depage::htmlform::elements::fieldset fieldsets@endlink
117120
* and @link depage::htmlform::elements::step steps@endlink:
118121
*
122+
* These are the most used elements that are added to the form with the add-method:
123+
*
124+
* @link depage::htmlform::elements::text input[type=text] @endlink
125+
*
126+
* $form->addText('input', array('label' => 'Normal Input'));
127+
*
128+
* @link depage::htmlform::elements::email input[type=email] @endlink
129+
*
130+
* $form->addEmail('email', array('label' => 'Email Input'));
131+
*
132+
*
133+
* @code
134+
<?php
135+
$form = new depage\htmlform\htmlform('simpleForm');
136+
137+
// some example inputs
138+
// @link depage::elements::text @endlink
139+
$form->addText('input', array('label' => 'Normal Input'));
140+
$form->addEmail('email', array('label' => 'Email Input'));
141+
$form->addEmail('url', array('label' => 'URL Input'));
142+
$form->addPassword('password', array('label' => 'Password Input'));
143+
$form->addDate('date', array('label' => 'Date Input'));
144+
$form->addNumber('number', array('label' => 'Number Input'));
145+
@endcode
146+
*
119147
* @namespace depage::htmlform::exceptions
120148
* @brief Htmlform exceptions
121149
*
@@ -176,7 +204,7 @@ function autoload($class)
176204
// Display the form.
177205
echo ($form);
178206
}
179-
?> @endcode
207+
@endcode
180208
*
181209
* You can find a list of available input-class in @link depage::htmlform::elements
182210
* elements@endlink.

0 commit comments

Comments
 (0)