Skip to content

Commit 9e5f3c1

Browse files
author
Bulat Shakirzyanov
committed
update doxygen formatting
1 parent b0f8e6b commit 9e5f3c1

File tree

2 files changed

+20
-20
lines changed

2 files changed

+20
-20
lines changed

ext/doc/Cassandra/Type.php

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -121,25 +121,31 @@ final static function timeuuid() {}
121121

122122
/**
123123
* Initialize a Collection type
124-
* <code>
124+
* @code{.php}
125+
* <?php
125126
* use Cassandra\Type;
127+
*
126128
* $collection = Type::collection(Type::int())
127129
* ->create(1, 2, 3, 4, 5, 6, 7, 8, 9);
130+
*
128131
* var_dump($collection);
129-
* </code>
132+
* @endcode
130133
* @param Type $type The type of values
131134
* @return Type The collection type
132135
*/
133136
final static function collection(Type $type) {}
134137

135138
/**
136139
* Initialize a map type
137-
* <code>
140+
* @code{.php}
141+
* <?php
138142
* use Cassandra\Type;
143+
*
139144
* $map = Type::map(Type::int(), Type::varchar())
140145
* ->create(1, "a", 2, "b", 3, "c", 4, "d", 5, "e", 6, "f")
146+
*
141147
* var_dump($map);
142-
* </code>
148+
* @endcode
143149
* @param Type $key_type The type of keys
144150
* @param Type $value_type The type of values
145151
* @return Type The map type
@@ -148,12 +154,15 @@ final static function map(Type $key_type, Type $value_type) {}
148154

149155
/**
150156
* Initialize a set type
151-
* <code>
157+
* @code{.php}
158+
* <?php
152159
* use Cassandra\Type;
160+
*
153161
* $set = Type::set(Type::varchar)
154162
* ->create("a", "b", "c", "d", "e", "f", "g", "h", "i", "j");
163+
*
155164
* var_dump($set);
156-
* </code>
165+
* @endcode
157166
* @param Type $type [description]
158167
*/
159168
final static function set(Type $type) {}

ext/doc/Cassandra/Type/Map.php

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -49,27 +49,18 @@ public function valueType() {}
4949
/**
5050
* Creates a new Cassandra\Map from the given values.
5151
*
52-
* <code>
52+
* @code{.php}
5353
* <?php
5454
* use Cassandra\Type;
5555
* use Cassandra\Uuid;
5656
*
5757
* $type = Type::map(Type::uuid(), Type::varchar());
58-
* // all examples below are equivalent
5958
* $map = $type->create(new Uuid(), 'first uuid',
6059
* new Uuid(), 'second uuid',
6160
* new Uuid(), 'third uuid');
62-
* // or
63-
* $map = $type->create(array(
64-
* new Uuid(), 'first uuid',
65-
* new Uuid(), 'second uuid',
66-
* new Uuid(), 'third uuid'
67-
* ));
68-
* // or
69-
* $map = $type->create(array(new Uuid(), 'first uuid'),
70-
* array(new Uuid(), 'second uuid'),
71-
* array(new Uuid(), 'third uuid'));
72-
* </code>
61+
*
62+
* var_dump($map);
63+
* @endcode
7364
*
7465
* @throws Exception\InvalidArgumentException when keys or values given are
7566
* of a different type than what
@@ -79,7 +70,7 @@ public function valueType() {}
7970
* is a key and each even value is a value for the
8071
* map, e.g. `create(key, value, key, value)`.
8172
* When no values given, creates an empty map.
82-
* @return Cassandra\Set A set with given values.
73+
* @return Cassandra\Map A set with given values.
8374
*/
8475
public function create($value = null) {}
8576
}

0 commit comments

Comments
 (0)