change the '@require:' to '@requires' so as to be compatible with JSDOC standards. put these directly inside the class definition comment block. update script to suggest this and update all source files to follow pattern. Caught a missing @requires in the EventPane.js file
git-svn-id: http://svn.openlayers.org/trunk/openlayers@1206 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
This commit is contained in:
@@ -7,11 +7,19 @@
|
||||
#
|
||||
# Dependencies are specified with a comment of the form:
|
||||
#
|
||||
# // @require: <file path>
|
||||
# // @requires <file path>
|
||||
#
|
||||
# e.g.
|
||||
#
|
||||
# // @require: Geo/DataSource.js
|
||||
# // @requires Geo/DataSource.js
|
||||
#
|
||||
# or (ideally) within a class comment definition
|
||||
#
|
||||
# /**
|
||||
# * @class
|
||||
# *
|
||||
# * @requires OpenLayers/Layer.js
|
||||
# */
|
||||
#
|
||||
# This script should be executed like so:
|
||||
#
|
||||
@@ -43,7 +51,7 @@ import sys
|
||||
|
||||
SUFFIX_JAVASCRIPT = ".js"
|
||||
|
||||
RE_REQUIRE = "@require: (.*)\n" # TODO: Ensure in comment?
|
||||
RE_REQUIRE = "@requires (.*)\n" # TODO: Ensure in comment?
|
||||
class SourceFile:
|
||||
"""
|
||||
Represents a Javascript source code file.
|
||||
|
||||
Reference in New Issue
Block a user