[TIMOB-9185] Tooling: support void return types

GitHub Issue	n/a
Type	New Feature
Priority	Low
Status	Closed
Resolution	Fixed
Resolution Date	2012-06-03T01:44:15.000+0000
Affected Version/s	Release 2.0.1
Fix Version/s	Release 2.1.0, Sprint 2012-11 Core
Components	Tooling
Labels	core
Reporter	Arthur Evans
Assignee	Bill Dawson
Created	2012-05-21T18:05:44.000+0000
Updated	2012-06-06T14:49:38.000+0000

Description

Currently, if we explicitly specify a return type of void, validate.py throws warnings:

returns:
    type: void

This works in docgen because it just formats the unrecognized return type, but it does throw a warning in validate. For some methods, we need to specify void as one of several return types, like:

returns:
  - type: void
  - type: Titanium.Blob

So we should really support it as a type value.

Comments

Bill Dawson 2012-05-29

Testing Notes
* Open apidoc/Titanium/Titanium.yml in an editor. * Find the documentation for the include method (it's the first method in the methods: section and should be on about line 58.) * Add a returns statement for it thusly: returns: {type: void} ... and save the file. (Note that you're just doing this for a test. We're not really going to change the documentation of the include method.) * Run python validate.py. You should get a validation error if you're testing the master branch, and no error if you are testing my pull request.
Wilson Luu 2012-06-06

Closing feature. Did not encounter any errors after following Bill's testing notes. Tested against master branch: version=2.1.0 module_apiversion=2 timestamp=06/06/12 14:33 githash=13b9cc7

JSON Source

[TIMOB-9185] Tooling: support void return types

Description

Comments

Testing Notes