Skip to content

Commit 3853f4d

Browse files
authored
Fix formatting of param. (#21942)
1 parent c20fa7b commit 3853f4d

File tree

1 file changed

+48
-48
lines changed

1 file changed

+48
-48
lines changed

site/source/docs/api_reference/bind.h.rst

Lines changed: 48 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ select_overload and select_const
9999
template<typename Signature>
100100
typename std::add_pointer<Signature>::type select_overload(typename std::add_pointer<Signature>::type fn)
101101
102-
:param typename std\:\:add_pointer<Signature>::type fn
102+
:param typename std\:\:add_pointer<Signature>::type fn:
103103

104104
.. cpp:function:: typename internal::MemberFunctionType<ClassType, Signature>::type select_overload()
105105

@@ -109,7 +109,7 @@ select_overload and select_const
109109
template<typename Signature, typename ClassType>
110110
typename internal::MemberFunctionType<ClassType, Signature>::type select_overload(Signature (ClassType::*fn))
111111
112-
:param Signature (ClassType::\*fn)
112+
:param Signature (ClassType::\*fn):
113113

114114
.. cpp:function:: auto select_const()
115115

@@ -119,7 +119,7 @@ select_overload and select_const
119119
template<typename ClassType, typename ReturnType, typename... Args>
120120
auto select_const(ReturnType (ClassType::*method)(Args...) const)
121121
122-
:param ReturnType (ClassType::\*method)(Args...) const
122+
:param ReturnType (ClassType::\*method)(Args...) const:
123123

124124

125125
.. cpp:function:: typename internal::CalculateLambdaSignature<LambdaType>::type optional_override(const LambdaType& fp)
@@ -130,7 +130,7 @@ select_overload and select_const
130130
template<typename LambdaType>
131131
typename internal::CalculateLambdaSignature<LambdaType>::type optional_override(const LambdaType& fp)
132132
133-
:param const LambdaType& fp
133+
:param const LambdaType& fp:
134134

135135

136136
Functions
@@ -186,7 +186,7 @@ Value tuples
186186

187187
Constructor.
188188

189-
:param const char* name
189+
:param const char* name:
190190

191191

192192
.. cpp:function:: ~value_array()
@@ -201,13 +201,13 @@ Value tuples
201201

202202
.. cpp:function:: value_array& element(Getter getter, Setter setter)
203203

204-
:param Getter getter. Note that ``Getter`` is a typename (templated type).
205-
:param Setter setter. Note that ``Setter`` is a typename (templated type).
204+
:param Getter getter: Note that ``Getter`` is a typename (templated type).
205+
:param Setter setter: Note that ``Setter`` is a typename (templated type).
206206

207207

208208
.. cpp:function:: value_array& element(index<Index>)
209209

210-
:param index<Index>:Note that ``Index`` is an integer template parameter.
210+
:param index<Index>: Note that ``Index`` is an integer template parameter.
211211

212212

213213

@@ -227,7 +227,7 @@ Value structs
227227

228228
Constructor.
229229

230-
:param const char* name
230+
:param const char* name:
231231

232232

233233
.. cpp:function:: ~value_object()
@@ -237,22 +237,22 @@ Value structs
237237

238238
.. cpp:function:: value_object& field(const char* fieldName, FieldType InstanceType::*field)
239239

240-
:param const char* fieldName.
241-
:param FieldType InstanceType\:\:\*field.
240+
:param const char* fieldName:
241+
:param FieldType InstanceType\:\:\*field:
242242

243243

244244

245245
.. cpp:function:: value_object& field(const char* fieldName, Getter getter, Setter setter)
246246

247-
:param const char* fieldName.
248-
:param Getter getter. Note that ``Getter`` is a typename (templated type).
249-
:param Setter setter. Note that ``Setter`` is a typename (templated type).
247+
:param const char* fieldName:
248+
:param Getter getter: Note that ``Getter`` is a typename (templated type).
249+
:param Setter setter: Note that ``Setter`` is a typename (templated type).
250250

251251

252252
.. cpp:function:: value_object& field(const char* fieldName, index<Index>)
253253

254-
:param const char* fieldName.
255-
:param index<Index>. Note that ``Index`` is an integer template parameter.
254+
:param const char* fieldName:
255+
:param index<Index>: Note that ``Index`` is an integer template parameter.
256256

257257

258258
Smart pointers
@@ -272,7 +272,7 @@ Smart pointers
272272

273273
.. cpp:function:: static void* share(void* v)
274274

275-
:param void* v
275+
:param void* v:
276276

277277

278278
.. cpp:function:: static PointerType* construct_null()
@@ -325,7 +325,7 @@ Smart pointers
325325

326326
.. cpp:function:: static element_type* get(const PointerType& ptr)
327327

328-
:param const PointerType& ptr
328+
:param const PointerType& ptr:
329329

330330
.. cpp:function:: static sharing_policy get_sharing_policy()
331331

@@ -369,7 +369,7 @@ Classes
369369
370370
Constructor.
371371

372-
:param val&& wrapped
372+
:param val&& wrapped:
373373
:param Args&&... args: Note that ``Args`` is a typename (templated type).
374374

375375

@@ -382,14 +382,14 @@ Classes
382382

383383
Constructor.
384384

385-
:param const char* name
385+
:param const char* name:
386386
:param Args&&... args: Note that ``Args`` is a typename (templated type).
387387
:returns: Note that ``ReturnType`` is a typename (templated type).
388388

389389

390390
.. cpp:function:: EMSCRIPTEN_WRAPPER(T)
391391

392-
:param T
392+
:param T:
393393

394394

395395
.. cpp:type:: base
@@ -442,7 +442,7 @@ Classes
442442
template<typename From, typename To>
443443
static To* convertPointer(From* ptr)
444444
445-
:param From* ptr
445+
:param From* ptr:
446446

447447

448448

@@ -494,7 +494,7 @@ Classes
494494
495495
Constructor.
496496

497-
:param const char* name
497+
:param const char* name:
498498

499499

500500
.. cpp:function:: const class_& smart_ptr(const char* name) const
@@ -505,7 +505,7 @@ Classes
505505
template<typename PointerType>
506506
EMSCRIPTEN_ALWAYS_INLINE const class_& smart_ptr(const char* name) const
507507
508-
:param const char* name.
508+
:param const char* name:
509509
:returns: |class_-function-returns|
510510

511511

@@ -552,7 +552,7 @@ Classes
552552
See :ref:`embind-external-constructors` for more information.
553553

554554

555-
:param Callable callable Note that ``Callable`` may be either a member function pointer, function pointer, ``std::function`` or function object.
555+
:param Callable callable: Note that ``Callable`` may be either a member function pointer, function pointer, ``std::function`` or function object.
556556
:param Policies... policies: |policies-argument|
557557
:returns: |class_-function-returns|
558558

@@ -565,8 +565,8 @@ Classes
565565
template<typename SmartPtr, typename... Args, typename... Policies>
566566
EMSCRIPTEN_ALWAYS_INLINE const class_& smart_ptr_constructor(const char* smartPtrName, SmartPtr (*factory)(Args...), Policies...) const
567567
568-
:param const char* smartPtrName
569-
:param SmartPtr (\*factory)(Args...)
568+
:param const char* smartPtrName:
569+
:param SmartPtr (\*factory)(Args...):
570570
:param Policies... policies: |policies-argument|
571571
:returns: |class_-function-returns|
572572

@@ -583,9 +583,9 @@ Classes
583583
::emscripten::constructor<ConstructorArgs...> = ::emscripten::constructor<>()
584584
) const
585585
586-
:param const char* wrapperClassName
587-
:param const char* pointerName
588-
:param emscripten\:\:constructor<ConstructorArgs...> constructor)
586+
:param const char* wrapperClassName:
587+
:param const char* pointerName:
588+
:param emscripten\:\:constructor<ConstructorArgs...> constructor):
589589
:returns: |class_-function-returns|
590590

591591

@@ -600,8 +600,8 @@ Classes
600600
::emscripten::constructor<ConstructorArgs...> constructor = ::emscripten::constructor<>()
601601
) const
602602
603-
:param const char* wrapperClassName
604-
:param \:\:emscripten\:\:constructor<ConstructorArgs...> constructor)
603+
:param const char* wrapperClassName:
604+
:param \:\:emscripten\:\:constructor<ConstructorArgs...> constructor):
605605

606606
:returns: |class_-function-returns|
607607

@@ -636,8 +636,8 @@ Classes
636636
.function<val(const MyClass&)>("myFunctor", std::bind(&my_functor_taking_this, _1));
637637
638638
639-
:param const char* methodName
640-
:param Callable callable Note that ``Callable`` may be either a member function pointer, function pointer, ``std::function`` or function object.
639+
:param const char* methodName:
640+
:param Callable callable: Note that ``Callable`` may be either a member function pointer, function pointer, ``std::function`` or function object.
641641
:param typename... Policies: |policies-argument|
642642
:returns: |class_-function-returns|
643643

@@ -650,8 +650,8 @@ Classes
650650
template<typename FieldType, typename = typename std::enable_if<!std::is_function<FieldType>::value>::type>
651651
EMSCRIPTEN_ALWAYS_INLINE const class_& property(const char* fieldName, const FieldType ClassType::*field) const
652652
653-
:param const char* fieldName
654-
:param const FieldType ClassType\:\:\*field
653+
:param const char* fieldName:
654+
:param const FieldType ClassType\:\:\*field:
655655

656656
:returns: |class_-function-returns|
657657

@@ -664,8 +664,8 @@ Classes
664664
template<typename FieldType, typename = typename std::enable_if<!std::is_function<FieldType>::value>::type>
665665
EMSCRIPTEN_ALWAYS_INLINE const class_& property(const char* fieldName, FieldType ClassType::*field) const
666666
667-
:param const char* fieldName
668-
:param FieldType ClassType\:\:\*field
667+
:param const char* fieldName:
668+
:param FieldType ClassType\:\:\*field:
669669

670670
:returns: |class_-function-returns|
671671

@@ -684,8 +684,8 @@ Classes
684684
``Getter`` is a function object, the property type must be specified as a template parameter as it cannot be deduced,
685685
e.g.: ``myClass.property<int>("myIntProperty", MyIntGetterFunctor());``
686686

687-
:param const char* fieldName
688-
:param Getter getter Note that ``Getter`` is a function template typename.
687+
:param const char* fieldName:
688+
:param Getter getter: Note that ``Getter`` is a function template typename.
689689
:returns: |class_-function-returns|
690690

691691

@@ -704,7 +704,7 @@ Classes
704704
property type must be specified as a template parameter as it cannot be deduced, e.g.:
705705
``myClass.property<int>("myIntProperty", MyIntGetterFunctor(), MyIntSetterFunctor());``
706706

707-
:param const char* fieldName
707+
:param const char* fieldName:
708708
:param Getter getter: Note that ``Getter`` is a function template typename.
709709
:param Setter setter: Note that ``Setter`` is a function template typename.
710710
:returns: |class_-function-returns|
@@ -727,8 +727,8 @@ Classes
727727
A method name specified in the human-readable well-known symbol format (e.g., ``@@species``)
728728
is bound using the named ``Symbol`` for JavaScript (e.g., ``Symbol.species``).
729729

730-
:param const char* methodName
731-
:param ReturnType (\*classMethod)(Args...)
730+
:param const char* methodName:
731+
:param ReturnType (\*classMethod)(Args...):
732732
:param Policies...: |policies-argument|
733733
:returns: |class_-function-returns|
734734

@@ -740,8 +740,8 @@ Classes
740740
template<typename FieldType>
741741
EMSCRIPTEN_ALWAYS_INLINE const class_& property(const char* fieldName, FieldType *field) const
742742
743-
:param const char* fieldName
744-
:param FieldType ClassType\:\:\*field
743+
:param const char* fieldName:
744+
:param FieldType ClassType\:\:\*field:
745745

746746
:returns: |class_-function-returns|
747747

@@ -762,7 +762,7 @@ Vectors
762762
763763
A function to register a ``std::vector<T>``.
764764

765-
:param const char* name
765+
:param const char* name:
766766

767767

768768
Maps
@@ -778,7 +778,7 @@ Maps
778778
779779
A function to register a ``std::map<K, V>``.
780780

781-
:param const char* name
781+
:param const char* name:
782782

783783

784784

@@ -808,7 +808,7 @@ Enums
808808

809809
Constructor.
810810

811-
:param const char* name
811+
:param const char* name:
812812

813813

814814
.. cpp:function:: enum_& value(const char* name, EnumType value)

0 commit comments

Comments
 (0)