Skip to content

Commit

Permalink
create a skeleton Properties object and add references to it
Browse files Browse the repository at this point in the history
  • Loading branch information
rendertom committed Aug 21, 2020
1 parent f2611c6 commit 5483724
Show file tree
Hide file tree
Showing 3 changed files with 131 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/application/application.rst
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,7 @@ The properties object provides methods to access and modify preference values.

**Type**

properties object; read-only; (Properties object).
:ref:`properties`, read-only;

----

Expand Down
129 changes: 129 additions & 0 deletions docs/general/properties.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
.. highlight:: javascript

.. _properties:

Properties object
===================

``app.properties``

**Description**

*add description here*

----

==========
Attributes
==========

None.

----

=======
Methods
=======

.. _properties.clearProperty:

Properties.clearProperty()
*********************************************

``app.properties.clearProperty()``

**Description**

*add description here*

**Parameters**

*add parameters here*

**Returns**

*add return value/type here*

----

.. _properties.doesPropertyExist:

Properties.doesPropertyExist()
*********************************************

``app.properties.doesPropertyExist()``

**Description**

*add description here*

**Parameters**

*add parameters here*

**Returns**

*add return value/type here*

----

.. _properties.getProperty:

Properties.getProperty()
*********************************************

``app.properties.getProperty()``

**Description**

*add description here*

**Parameters**

*add parameters here*

**Returns**

*add return value/type here*

----

.. _properties.isPropertyReadOnly:

Properties.isPropertyReadOnly()
*********************************************

``app.properties.isPropertyReadOnly()``

**Description**

*add description here*

**Parameters**

*add parameters here*

**Returns**

*add return value/type here*

----

.. _properties.setProperty:

Properties.setProperty()
*********************************************

``app.properties.setProperty()``

**Description**

*add description here*

**Parameters**

*add parameters here*

**Returns**

*add return value/type here*
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Welcome to the Premiere Pro Scripting Guide!
general/production
general/project
general/projectmanager
general/properties
general/sourcemonitor

.. toctree::
Expand Down

0 comments on commit 5483724

Please sign in to comment.