Skip to main content

PureData documentation tools

Project description

# PDDOC
PureData documentation generator

## XML
for generation *-help.pd files used **pddoc** format

### properties

```xml
<properties>
<property name="PROP" type="TYPE">description</property>
</properties>
```

- **name** (required)
- **type** (required):
- int
- float
- symbol
- atom - int, float or symbol
- list - list of atoms
- alias - alias for other property
- flag - property that is **True** when specified, otherwise **False**
- **readonly**
- **units** - value unit from list:
- herz
- kiloherz
- decibell
- millisecond
- second
- bpm
- percent
- **minvalue** - minimum allowed value
- **maxvalue** - maximum allowed value
- **default** - default value, if not specified
- **enum** - comma separated list of allowed values
```xml
<property enum="A,B,C"/>
```

### inlets
```xml
<inlets dynamic="true">
<inlet type="TYPE" number="XXX">
<xinfo on="symbol"></xinfo>
</inlet>
</inlets>
```

- **dynamic** *(optional)* - if True, external has dynamic number of inlets, otherwise fixed.
- **type** *(optional)* - inlet type:
- control
- audio
- **number** *(optional)* - manually specified inlet number: number, or "n", or "..."
- **on** *(optional)* - describe reaction on input data type. Data types:
- atom
- int
- float
- list
- symbol
- pointer
- any
- data - for additional data types






Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pddoc-0.4.0.tar.gz (72.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pddoc-0.4.0-py2-none-any.whl (155.1 kB view details)

Uploaded Python 2

File details

Details for the file pddoc-0.4.0.tar.gz.

File metadata

  • Download URL: pddoc-0.4.0.tar.gz
  • Upload date:
  • Size: 72.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pddoc-0.4.0.tar.gz
Algorithm Hash digest
SHA256 035074e1b96bfa5f94a5b265d41b7d55efb449002de34afe82c22114a2144dd1
MD5 5b33c6248d2db93c5106b8d81ee740a9
BLAKE2b-256 89454c7b0d765b89ca42c362d2c79e8aaa101717e2af74d67c7325de48d524f5

See more details on using hashes here.

File details

Details for the file pddoc-0.4.0-py2-none-any.whl.

File metadata

File hashes

Hashes for pddoc-0.4.0-py2-none-any.whl
Algorithm Hash digest
SHA256 fe03fb55f48ab97947170ed8e6bc103cf21384e09f1ff62ff569d85c8cbee9e8
MD5 f2ef1835a2756114219b434ccdcfb135
BLAKE2b-256 01642f2b863165cc179893cfb4d78475b37ba3bc75393116094cac750d197d90

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page