From 589b277e1c5bc5932be727958daf9168f6f4a2c0 Mon Sep 17 00:00:00 2001 From: Paul Dowsett Date: Mon, 6 Feb 2012 17:16:58 +0000 Subject: [PATCH 1/2] TIDOC-360: Make corrections to templates --- apidoc/templates/create_proxy_method.yml.mako | 4 ++-- apidoc/templates/vsdoc/method.vsdoc.html | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/apidoc/templates/create_proxy_method.yml.mako b/apidoc/templates/create_proxy_method.yml.mako index 324c26af127..5da6b678ddf 100644 --- a/apidoc/templates/create_proxy_method.yml.mako +++ b/apidoc/templates/create_proxy_method.yml.mako @@ -1,10 +1,10 @@ --- name: create${data["proxy_name"].split(".")[-1]} -summary: Create and return an instance of <${data["proxy_name"]}>. +summary: Creates and returns an instance of <${data["proxy_name"]}>. parameters: - name: parameters type: Dictionary<${data["proxy_name"]}> - summary: (Optional) A dictionary object with properties as defined in <${data["proxy_name"]}>. + summary: (Optional) Properties as defined in <${data["proxy_name"]}>. returns: type: ${data["proxy_name"]} % if "platforms" in data: diff --git a/apidoc/templates/vsdoc/method.vsdoc.html b/apidoc/templates/vsdoc/method.vsdoc.html index 92bc56f8c78..92680ea5b24 100644 --- a/apidoc/templates/vsdoc/method.vsdoc.html +++ b/apidoc/templates/vsdoc/method.vsdoc.html @@ -5,14 +5,14 @@ return safeWord.get(str,str) def getReturnType(str, defaultValue): - needle = 'create and return an instance of ' + needle = 'Creates and returns an instance of ' if needle in str: return re.split(needle,str)[-1] else: return defaultValue def getTypeInstance(str, defaultValue): - needle = 'create and return an instance of ' + needle = 'Creates and returns an instance of ' if needle in str: return 'new ' + re.split(needle,str)[-1] + '()' else: From 5d17eb14ca1f516ab090fe9d1750b2f563e1f62b Mon Sep 17 00:00:00 2001 From: Paul Dowsett Date: Tue, 7 Feb 2012 18:05:24 +0000 Subject: [PATCH 2/2] TIDOC-360 TIDOC-136: Make corrections to templates rev1 --- apidoc/templates/create_proxy_method.yml.mako | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/apidoc/templates/create_proxy_method.yml.mako b/apidoc/templates/create_proxy_method.yml.mako index 5da6b678ddf..e5b72d7f242 100644 --- a/apidoc/templates/create_proxy_method.yml.mako +++ b/apidoc/templates/create_proxy_method.yml.mako @@ -4,7 +4,8 @@ summary: Creates and returns an instance of <${data["proxy_name"]}>. parameters: - name: parameters type: Dictionary<${data["proxy_name"]}> - summary: (Optional) Properties as defined in <${data["proxy_name"]}>. + summary: Properties to set on a new object, including any defined by <${data["proxy_name"]}> except those marked not-creation or read-only. + optional: true returns: type: ${data["proxy_name"]} % if "platforms" in data: