10. Testing object descriptions

func_without_module(a, b, *c[, d])

Does something.

func_without_body()
func_with_unknown_field()

: :

: empty field name:

Field_name:
Field_name all lower:
 
FIELD_NAME:
FIELD_NAME ALL CAPS:
 
Field_Name:
Field_Name All Word Caps:
 
Field_name:
Field_name First word cap:
 
FIELd_name:
FIELd_name PARTial caps:
 
func_noindex()
foolib.func_with_module()

Referring to func with no index. Referring to nothing.

mod.func_in_module()
class mod.Cls
meth1()
static meths()
attr
Cls.meth2()
exception errmod.Error(arg1, arg2)
mod.var
func_without_module2() → annotation
long(parameter, list)
another one
class TimeInt

Has only one parameter (triggers special behavior...)

Parameters:moo (Moo) – Moo
class Time(hour, minute, isdst)
Parameters:
  • year (TimeInt) – The year.
  • minute (TimeInt) – The minute.
  • isdst – whether it’s DST
  • hour (DuplicateType) – Some parameter
  • hour – Duplicate param. Should not lead to crashes.
  • extcls (Cls) – A class from another module.
Returns:

a new Time instance

Return type:

Time

Raises:

ValueError – if the values are out of range

Variables:
  • hour (int) – like hour
  • minute (int) – like minute

11. C items

Sphinx_DoSomething()
SphinxStruct.member
SPHINX_USE_PYTHON
SphinxType
sphinx_global

12. Javascript items

foo()
bar
bar.baz(href, callback[, errback])
Arguments:
  • href (string) – The location of the resource.
  • callback – Get’s called with the data returned by the resource.
Throws:

InvalidHref – If the href is invalid.

Returns:

undefined

bar.spam

13. References

Referencing mod.Cls or mod.Cls should be the same.

With target: Sphinx_DoSomething() (parentheses are handled), SphinxStruct.member, SPHINX_USE_PYTHON, SphinxType * (pointer is handled), sphinx_global.

Without target: CFunction(). malloc().

foo() foo()

bar bar.baz() bar.baz() baz()

bar.baz

14. Others

HOME
-c command
-c
+p
arg

Link to perl +p and arg

commit
-p

Link to hg commit and git commit -p.

15. User markup

myobj(parameter)

Description of userdesc.

Referencing myobj.

16. CPP domain

class n::Array
T &operator[](unsigned j)
const T &operator[](unsigned j) const