[Commits] r302 - in core/trunk/geoext: build build/apidoc_config lib/GeoExt/data lib/GeoExt/widgets
commits at geoext.org
commits at geoext.org
Tue Mar 31 10:52:42 CEST 2009
Author: ahocevar
Date: 2009-03-31 10:52:41 +0200 (Tue, 31 Mar 2009)
New Revision: 302
Added:
core/trunk/geoext/build/apidoc_config/
core/trunk/geoext/build/apidoc_config/Languages.txt
core/trunk/geoext/build/apidoc_config/Menu.txt
core/trunk/geoext/build/apidoc_config/Topics.txt
Modified:
core/trunk/geoext/lib/GeoExt/data/LayerRecord.js
core/trunk/geoext/lib/GeoExt/data/LayerStore.js
core/trunk/geoext/lib/GeoExt/widgets/MapPanel.js
Log:
added apidoc_config folder with initial NaturalDocs configuration. Also
modified ND comments in some js files to produce nice output
(closes #33)
Added: core/trunk/geoext/build/apidoc_config/Languages.txt
===================================================================
--- core/trunk/geoext/build/apidoc_config/Languages.txt (rev 0)
+++ core/trunk/geoext/build/apidoc_config/Languages.txt 2009-03-31 08:52:41 UTC (rev 302)
@@ -0,0 +1,113 @@
+Format: 1.4
+
+# This is the Natural Docs languages file for this project. If you change
+# anything here, it will apply to THIS PROJECT ONLY. If you'd like to change
+# something for all your projects, edit the Languages.txt in Natural Docs'
+# Config directory instead.
+
+
+# You can prevent certain file extensions from being scanned like this:
+# Ignore Extensions: [extension] [extension] ...
+
+
+#-------------------------------------------------------------------------------
+# SYNTAX:
+#
+# Unlike other Natural Docs configuration files, in this file all comments
+# MUST be alone on a line. Some languages deal with the # character, so you
+# cannot put comments on the same line as content.
+#
+# Also, all lists are separated with spaces, not commas, again because some
+# languages may need to use them.
+#
+# Language: [name]
+# Alter Language: [name]
+# Defines a new language or alters an existing one. Its name can use any
+# characters. If any of the properties below have an add/replace form, you
+# must use that when using Alter Language.
+#
+# The language Shebang Script is special. It's entry is only used for
+# extensions, and files with those extensions have their shebang (#!) lines
+# read to determine the real language of the file. Extensionless files are
+# always treated this way.
+#
+# The language Text File is also special. It's treated as one big comment
+# so you can put Natural Docs content in them without special symbols. Also,
+# if you don't specify a package separator, ignored prefixes, or enum value
+# behavior, it will copy those settings from the language that is used most
+# in the source tree.
+#
+# Extensions: [extension] [extension] ...
+# [Add/Replace] Extensions: [extension] [extension] ...
+# Defines the file extensions of the language's source files. You can
+# redefine extensions found in the main languages file. You can use * to
+# mean any undefined extension.
+#
+# Shebang Strings: [string] [string] ...
+# [Add/Replace] Shebang Strings: [string] [string] ...
+# Defines a list of strings that can appear in the shebang (#!) line to
+# designate that it's part of the language. You can redefine strings found
+# in the main languages file.
+#
+# Ignore Prefixes in Index: [prefix] [prefix] ...
+# [Add/Replace] Ignored Prefixes in Index: [prefix] [prefix] ...
+#
+# Ignore [Topic Type] Prefixes in Index: [prefix] [prefix] ...
+# [Add/Replace] Ignored [Topic Type] Prefixes in Index: [prefix] [prefix] ...
+# Specifies prefixes that should be ignored when sorting symbols in an
+# index. Can be specified in general or for a specific topic type.
+#
+#------------------------------------------------------------------------------
+# For basic language support only:
+#
+# Line Comments: [symbol] [symbol] ...
+# Defines a space-separated list of symbols that are used for line comments,
+# if any.
+#
+# Block Comments: [opening sym] [closing sym] [opening sym] [closing sym] ...
+# Defines a space-separated list of symbol pairs that are used for block
+# comments, if any.
+#
+# Package Separator: [symbol]
+# Defines the default package separator symbol. The default is a dot.
+#
+# [Topic Type] Prototype Enders: [symbol] [symbol] ...
+# When defined, Natural Docs will attempt to get a prototype from the code
+# immediately following the topic type. It stops when it reaches one of
+# these symbols. Use \n for line breaks.
+#
+# Line Extender: [symbol]
+# Defines the symbol that allows a prototype to span multiple lines if
+# normally a line break would end it.
+#
+# Enum Values: [global|under type|under parent]
+# Defines how enum values are referenced. The default is global.
+# global - Values are always global, referenced as 'value'.
+# under type - Values are under the enum type, referenced as
+# 'package.enum.value'.
+# under parent - Values are under the enum's parent, referenced as
+# 'package.value'.
+#
+# Perl Package: [perl package]
+# Specifies the Perl package used to fine-tune the language behavior in ways
+# too complex to do in this file.
+#
+#------------------------------------------------------------------------------
+# For full language support only:
+#
+# Full Language Support: [perl package]
+# Specifies the Perl package that has the parsing routines necessary for full
+# language support.
+#
+#-------------------------------------------------------------------------------
+
+# The following languages are defined in the main file, if you'd like to alter
+# them:
+#
+# Text File, Shebang Script, C/C++, C#, Java, JavaScript, Perl, Python,
+# PHP, SQL, Visual Basic, Pascal, Assembly, Ada, Tcl, Ruby, Makefile,
+# ActionScript, ColdFusion, R, Fortran
+
+# If you add a language that you think would be useful to other developers
+# and should be included in Natural Docs by default, please e-mail it to
+# languages [at] naturaldocs [dot] org.
Property changes on: core/trunk/geoext/build/apidoc_config/Languages.txt
___________________________________________________________________
Name: svn:keywords
+ Id Revision
Name: svn:eol-style
+ native
Added: core/trunk/geoext/build/apidoc_config/Menu.txt
===================================================================
--- core/trunk/geoext/build/apidoc_config/Menu.txt (rev 0)
+++ core/trunk/geoext/build/apidoc_config/Menu.txt 2009-03-31 08:52:41 UTC (rev 302)
@@ -0,0 +1,72 @@
+Format: 1.4
+
+
+# You can add a title and sub-title to your menu like this:
+# Title: [project name]
+# SubTitle: [subtitle]
+
+# You can add a footer to your documentation like this:
+# Footer: [text]
+# If you want to add a copyright notice, this would be the place to do it.
+
+# You can add a timestamp to your documentation like one of these:
+# Timestamp: Generated on month day, year
+# Timestamp: Updated mm/dd/yyyy
+# Timestamp: Last updated mon day
+#
+# m - One or two digit month. January is "1"
+# mm - Always two digit month. January is "01"
+# mon - Short month word. January is "Jan"
+# month - Long month word. January is "January"
+# d - One or two digit day. 1 is "1"
+# dd - Always two digit day. 1 is "01"
+# day - Day with letter extension. 1 is "1st"
+# yy - Two digit year. 2006 is "06"
+# yyyy - Four digit year. 2006 is "2006"
+# year - Four digit year. 2006 is "2006"
+
+
+# --------------------------------------------------------------------------
+#
+# Cut and paste the lines below to change the order in which your files
+# appear on the menu. Don't worry about adding or removing files, Natural
+# Docs will take care of that.
+#
+# You can further organize the menu by grouping the entries. Add a
+# "Group: [name] {" line to start a group, and add a "}" to end it.
+#
+# You can add text and web links to the menu by adding "Text: [text]" and
+# "Link: [name] ([URL])" lines, respectively.
+#
+# The formatting and comments are auto-generated, so don't worry about
+# neatness when editing the file. Natural Docs will clean it up the next
+# time it is run. When working with groups, just deal with the braces and
+# forget about the indentation and comments.
+#
+# --------------------------------------------------------------------------
+
+
+Group: Data {
+
+ File: FeatureReader (GeoExt/data/FeatureReader.js)
+ File: FeatureRecord (GeoExt/data/FeatureRecord.js)
+ File: FeatureStoreMediator (GeoExt/data/FeatureStoreMediator.js)
+ File: LayerReader (GeoExt/data/LayerReader.js)
+ File: LayerRecord (GeoExt/data/LayerRecord.js)
+ File: LayerStoreMediator (GeoExt/data/LayerStoreMediator.js)
+ File: LayerStoreMixin (GeoExt/data/LayerStore.js)
+ File: ProtocolProxy (GeoExt/data/ProtocolProxy.js)
+ } # Group: Data
+
+File: MapPanel (GeoExt/widgets/MapPanel.js)
+
+Group: Index {
+
+ Index: Everything
+ Class Index: Classes
+ Function Index: Functions
+ Property Index: Properties
+ Constructor Index: Constructor
+ XType Index: XTypes
+ } # Group: Index
+
Property changes on: core/trunk/geoext/build/apidoc_config/Menu.txt
___________________________________________________________________
Name: svn:keywords
+ Id Revision
Name: svn:eol-style
+ native
Added: core/trunk/geoext/build/apidoc_config/Topics.txt
===================================================================
--- core/trunk/geoext/build/apidoc_config/Topics.txt (rev 0)
+++ core/trunk/geoext/build/apidoc_config/Topics.txt 2009-03-31 08:52:41 UTC (rev 302)
@@ -0,0 +1,117 @@
+Format: 1.4
+
+# This is the Natural Docs topics file for this project. If you change anything
+# here, it will apply to THIS PROJECT ONLY. If you'd like to change something
+# for all your projects, edit the Topics.txt in Natural Docs' Config directory
+# instead.
+
+
+# If you'd like to prevent keywords from being recognized by Natural Docs, you
+# can do it like this:
+# Ignore Keywords: [keyword], [keyword], ...
+#
+# Or you can use the list syntax like how they are defined:
+# Ignore Keywords:
+# [keyword]
+# [keyword], [plural keyword]
+# ...
+
+
+#-------------------------------------------------------------------------------
+# SYNTAX:
+#
+# Topic Type: [name]
+# Alter Topic Type: [name]
+# Creates a new topic type or alters one from the main file. Each type gets
+# its own index and behavior settings. Its name can have letters, numbers,
+# spaces, and these charaters: - / . '
+#
+# Plural: [name]
+# Sets the plural name of the topic type, if different.
+#
+# Keywords:
+# [keyword]
+# [keyword], [plural keyword]
+# ...
+# Defines or adds to the list of keywords for the topic type. They may only
+# contain letters, numbers, and spaces and are not case sensitive. Plural
+# keywords are used for list topics. You can redefine keywords found in the
+# main topics file.
+#
+# Index: [yes|no]
+# Whether the topics get their own index. Defaults to yes. Everything is
+# included in the general index regardless of this setting.
+#
+# Scope: [normal|start|end|always global]
+# How the topics affects scope. Defaults to normal.
+# normal - Topics stay within the current scope.
+# start - Topics start a new scope for all the topics beneath it,
+# like class topics.
+# end - Topics reset the scope back to global for all the topics
+# beneath it.
+# always global - Topics are defined as global, but do not change the scope
+# for any other topics.
+#
+# Class Hierarchy: [yes|no]
+# Whether the topics are part of the class hierarchy. Defaults to no.
+#
+# Page Title If First: [yes|no]
+# Whether the topic's title becomes the page title if it's the first one in
+# a file. Defaults to no.
+#
+# Break Lists: [yes|no]
+# Whether list topics should be broken into individual topics in the output.
+# Defaults to no.
+#
+# Can Group With: [type], [type], ...
+# Defines a list of topic types that this one can possibly be grouped with.
+# Defaults to none.
+#-------------------------------------------------------------------------------
+
+# The following topics are defined in the main file, if you'd like to alter
+# their behavior or add keywords:
+#
+# Generic, Class, Interface, Section, File, Group, Function, Variable,
+# Property, Type, Constant, Enumeration, Event, Delegate, Macro,
+# Database, Database Table, Database View, Database Index, Database
+# Cursor, Database Trigger, Cookie, Build Target
+
+# If you add something that you think would be useful to other developers
+# and should be included in Natural Docs by default, please e-mail it to
+# topics [at] naturaldocs [dot] org.
+
+
+Topic Type: Constructor
+
+ Class Hierarchy: Yes
+ Keywords:
+ constructor
+ initialize
+ initcomponent
+
+
+Alter Topic Type: Function
+
+ Add Keywords:
+ apimethod
+ apifunction
+
+
+Alter Topic Type: Property
+
+ Add Keywords:
+ apiproperty
+
+
+Topic Type: Node Type
+
+ Plural: Node Types
+ Keywords:
+ nodetype
+
+
+Topic Type: XType
+
+ Plural: XTypes
+ Keywords:
+ xtype
Property changes on: core/trunk/geoext/build/apidoc_config/Topics.txt
___________________________________________________________________
Name: svn:keywords
+ Id Revision
Name: svn:eol-style
+ native
Modified: core/trunk/geoext/lib/GeoExt/data/LayerRecord.js
===================================================================
--- core/trunk/geoext/lib/GeoExt/data/LayerRecord.js 2009-03-30 23:31:01 UTC (rev 301)
+++ core/trunk/geoext/lib/GeoExt/data/LayerRecord.js 2009-03-31 08:52:41 UTC (rev 302)
@@ -17,6 +17,13 @@
* Inherits from
* - {Ext.data.Record}
*/
+/**
+ * Constructor: GeoExt.data.LayerRecord
+ *
+ * Parameters:
+ * data - {Object} data object for the record
+ * id - {String} id of the record
+ */
GeoExt.data.LayerRecord = Ext.data.Record.create([
{name: "layer"},
{name: "title", type: "string", mapping: "name"}
Modified: core/trunk/geoext/lib/GeoExt/data/LayerStore.js
===================================================================
--- core/trunk/geoext/lib/GeoExt/data/LayerStore.js 2009-03-30 23:31:01 UTC (rev 301)
+++ core/trunk/geoext/lib/GeoExt/data/LayerStore.js 2009-03-31 08:52:41 UTC (rev 302)
@@ -8,7 +8,7 @@
Ext.namespace("GeoExt.data");
/**
- * Class: LayerStoreMixin
+ * Class: GeoExt.data.LayerStoreMixin
* A store that synchronizes a layers array of an {OpenLayers.Map} with a
* layer store holding {<GeoExt.data.LayerRecord>} entries.
*
@@ -21,14 +21,14 @@
* });
* (end)
*
- * For convenience, a {GeoExt.data.LayerStore} class is available as a
+ * For convenience, a {<GeoExt.data.LayerStore>} class is available as a
* shortcut to the Ext.extend sequence in the above code snippet. The above
* is equivalent to:
* (start code)
* var store = new GeoExt.data.LayerStore({
* map: myMap,
* layers: myLayers
- * })
+ * });
* (end)
*/
GeoExt.data.LayerStoreMixin = {
@@ -47,7 +47,7 @@
reader: null,
/**
- * Constructor: GeoExt.data.LayerStore
+ * Constructor: GeoExt.data.LayerStoreMixin
*
* Parameters:
* config - {Object}
@@ -191,9 +191,21 @@
/**
* Class: GeoExt.data.LayerStore
- * Default implementation of an {Ext.data.Store} enhanced with
+ * Default implementation of an {Ext.data.Store} extended with
* {<GeoExt.data.LayerStoreMixin>}
+ *
+ * Inherits from:
+ * - {Ext.data.Store}
+ * - {<GeoExt.data.LayerStoreMixin>}
*/
+/**
+ * Constructor: GeoExt.data.LayerStore
+ *
+ * Parameters:
+ * config - {Object} See {<GeoExt.data.LayerStoreMixin>} and
+ * http://extjs.com/deploy/dev/docs/?class=Ext.data.Store for valid config
+ * options.
+ */
GeoExt.data.LayerStore = Ext.extend(
Ext.data.Store,
GeoExt.data.LayerStoreMixin
Modified: core/trunk/geoext/lib/GeoExt/widgets/MapPanel.js
===================================================================
--- core/trunk/geoext/lib/GeoExt/widgets/MapPanel.js 2009-03-30 23:31:01 UTC (rev 301)
+++ core/trunk/geoext/lib/GeoExt/widgets/MapPanel.js 2009-03-31 08:52:41 UTC (rev 302)
@@ -186,4 +186,7 @@
});
+/**
+ * XType: gx_mappanel
+ */
Ext.reg('gx_mappanel', GeoExt.MapPanel);
More information about the Commits
mailing list