pyVmomi reStructured Text Documentation

This external documentation for pyVmomi was generated using Googly Docs
(aka Google Standard Documentation) which renders very cleanly in
GitHub. Internal documentation for a class should be done in Sphinx
format because tools like pyCharm and Eclipse can use that documentation
as a hint for code completion.

Note: External docs as Googly Docs, internal docs as Sphinx.

Closes bug#15
This commit is contained in:
Shawn Hartsock
2014-06-17 12:45:07 -04:00
parent 52f1ae0d75
commit 15f7be9a52
2755 changed files with 97204 additions and 0 deletions

View File

@@ -0,0 +1,22 @@
.. _str: https://docs.python.org/2/library/stdtypes.html
.. _vSphere API 4.0: ../vim/version.rst#vimversionversion5
.. _vim.Description: ../vim/Description.rst
.. _vmodl.KeyAnyValue: ../vmodl/KeyAnyValue.rst
vim.ExtendedDescription
=======================
:extends: vim.Description_
:since: `vSphere API 4.0`_
Attributes:
messageCatalogKeyPrefix (`str`_):
Key to the localized message string in the catalog. If the localized string contains parameters, values to the parameters will be provided in #messageArg. E.g: If the message in the catalog is "IP address is {address}", value for "address" will be provided by #messageArg. Both summary and label in Description will have a corresponding entry in the message catalog with the keys.summary and.label respectively. Description.summary and Description.label will contain the strings in server locale.
messageArg (`vmodl.KeyAnyValue`_, optional):
Provides named arguments that can be used to localize the message in the catalog.