NaturalDocs status

classic Classic list List threaded Threaded
25 messages Options
12
Reply | Threaded
Open this post in threaded view
|

NaturalDocs status

Christopher Schmidt-2
I've added docs for all the Control classes to the sandbox. This means
that we have:
 * BaseTypes.js
 * Console.js
 * Control/* , Control.js
 * Events.s
 * Feature/* , Feature.js
 * Geometry/*.js, Geometry.js
 * Handler/*.js, Handler.js
 * Icon.js
 * Some of Layer/*
 * Incomplete Map.js
 * Marker/Box.js, Marker.js
 * Popup.js
 * Tile/*.js, Tile.js

This means we have remaining:
 * Some Format/* classes (4)
 * Some Layer/* classes (17)
 * Most of Map.js (1)
 * All of the Popup/* classes (2)
 * All of the Renderer/*, Renderer.js classes (4)
 * Util.js (1)

A total of 29 files left needing docs (and some needing improved docs).

If you have sandbox access, please feel free to grab one and redo the
docs (or grab an existing file and improve the docs). If you don't have
sandbox access, you can ask for it[1]. You may not get your name in
lights, but at the very least, you'll know you helped make the
(OpenLayers) world a better place.

[1] http://trac.openlayers.org/wiki/FrequentlyAskedQuestions#HowdocanIgetcommitaccesstotheSVNrepository

Regards,
--
Christopher Schmidt
MetaCarta
_______________________________________________
Dev mailing list
[hidden email]
http://openlayers.org/mailman/listinfo/dev
Reply | Threaded
Open this post in threaded view
|

Re: NaturalDocs status

Christopher Schmidt-2
On Wed, Jun 27, 2007 at 10:29:14PM -0400, Christopher Schmidt wrote:
> This means we have remaining:
>  * Some Format/* classes (4)
 Now complete.
 
 
A total of 25 files left needing docs (and some needing improved docs).
 * Some Layer/* classes (17)
 * Most of Map.js (1)
 * All of the Popup/* classes (2)
 * All of the Renderer/*, Renderer.js classes (4)
 * Util.js (1)

Regards,
--
Christopher Schmidt
MetaCarta
_______________________________________________
Dev mailing list
[hidden email]
http://openlayers.org/mailman/listinfo/dev
Reply | Threaded
Open this post in threaded view
|

Re: NaturalDocs status

Erik Uzureau-3
I am taking the Popup classes right now

On 6/27/07, Christopher Schmidt <[hidden email]> wrote:

> On Wed, Jun 27, 2007 at 10:29:14PM -0400, Christopher Schmidt wrote:
> > This means we have remaining:
> >  * Some Format/* classes (4)
>  Now complete.
>
>
> A total of 25 files left needing docs (and some needing improved docs).
>  * Some Layer/* classes (17)
>  * Most of Map.js (1)
>  * All of the Popup/* classes (2)
>  * All of the Renderer/*, Renderer.js classes (4)
>  * Util.js (1)
>
> Regards,
> --
> Christopher Schmidt
> MetaCarta
> _______________________________________________
> Dev mailing list
> [hidden email]
> http://openlayers.org/mailman/listinfo/dev
>
_______________________________________________
Dev mailing list
[hidden email]
http://openlayers.org/mailman/listinfo/dev
Reply | Threaded
Open this post in threaded view
|

Re: NaturalDocs status

Erik Uzureau-3
I'll try to do Map and Util before going to bed.

On 6/27/07, Erik Uzureau <[hidden email]> wrote:

> I am taking the Popup classes right now
>
> On 6/27/07, Christopher Schmidt <[hidden email]> wrote:
> > On Wed, Jun 27, 2007 at 10:29:14PM -0400, Christopher Schmidt wrote:
> > > This means we have remaining:
> > >  * Some Format/* classes (4)
> >  Now complete.
> >
> >
> > A total of 25 files left needing docs (and some needing improved docs).
> >  * Some Layer/* classes (17)
> >  * Most of Map.js (1)
> >  * All of the Popup/* classes (2)
> >  * All of the Renderer/*, Renderer.js classes (4)
> >  * Util.js (1)
> >
> > Regards,
> > --
> > Christopher Schmidt
> > MetaCarta
> > _______________________________________________
> > Dev mailing list
> > [hidden email]
> > http://openlayers.org/mailman/listinfo/dev
> >
>
_______________________________________________
Dev mailing list
[hidden email]
http://openlayers.org/mailman/listinfo/dev
Reply | Threaded
Open this post in threaded view
|

Re: NaturalDocs status

Erik Uzureau-3
Now a  total of 21 files left needing docs (and some needing improved docs).
  * Some Layer/* classes (17)
 * All of the Renderer/*, Renderer.js classes (4)

---e

On 6/27/07, Erik Uzureau <[hidden email]> wrote:

> I'll try to do Map and Util before going to bed.
>
> On 6/27/07, Erik Uzureau <[hidden email]> wrote:
> > I am taking the Popup classes right now
> >
> > On 6/27/07, Christopher Schmidt <[hidden email]> wrote:
> > > On Wed, Jun 27, 2007 at 10:29:14PM -0400, Christopher Schmidt wrote:
> > > > This means we have remaining:
> > > >  * Some Format/* classes (4)
> > >  Now complete.
> > >
> > >
> > > A total of 25 files left needing docs (and some needing improved docs).
> > >  * Some Layer/* classes (17)
> > >  * Most of Map.js (1)
> > >  * All of the Popup/* classes (2)
> > >  * All of the Renderer/*, Renderer.js classes (4)
> > >  * Util.js (1)
> > >
> > > Regards,
> > > --
> > > Christopher Schmidt
> > > MetaCarta
> > > _______________________________________________
> > > Dev mailing list
> > > [hidden email]
> > > http://openlayers.org/mailman/listinfo/dev
> > >
> >
>
_______________________________________________
Dev mailing list
[hidden email]
http://openlayers.org/mailman/listinfo/dev
Reply | Threaded
Open this post in threaded view
|

Re: NaturalDocs status

Christopher Schmidt-2
On Thu, Jun 28, 2007 at 01:23:54AM -0500, Erik Uzureau wrote:
> Now a  total of 21 files left needing docs (and some needing improved docs).
>  * Some Layer/* classes (17)
> * All of the Renderer/*, Renderer.js classes (4)

I got renderer.js before I passed out last night, and it looks like Tim
got Renderer.VML and cleaned up our menus for us (yay).

So:
 Some Layer/* classes
 Renderer/Elements.js
 Renderer/SVG.js

Leaving us at 19

Regards,
--
Christopher Schmidt
MetaCarta
_______________________________________________
Dev mailing list
[hidden email]
http://openlayers.org/mailman/listinfo/dev
Reply | Threaded
Open this post in threaded view
|

Re: NaturalDocs status

Christopher Schmidt-2
On Thu, Jun 28, 2007 at 06:39:59AM -0400, Christopher Schmidt wrote:

> On Thu, Jun 28, 2007 at 01:23:54AM -0500, Erik Uzureau wrote:
> > Now a  total of 21 files left needing docs (and some needing improved docs).
> >  * Some Layer/* classes (17)
> > * All of the Renderer/*, Renderer.js classes (4)
>
> I got renderer.js before I passed out last night, and it looks like Tim
> got Renderer.VML and cleaned up our menus for us (yay).
>
> So:
>  Some Layer/* classes
>  Renderer/Elements.js
>  Renderer/SVG.js

Did a couple more layers. Of the Layer classes:

Done:
./Boxes.js
./GeoRSS.js
./GML.js
./Image.js
./Markers.js
./Text.js
./Vector.js
./WMS/Untiled.js
./WorldWind.js

Not done: (14)
./EventPane.js
./FixedZoomLevels.js
./Google.js
./Grid.js
./HTTPRequest.js
./KaMap.js
./MapServer/Untiled.js
./MapServer.js
./MultiMap.js
./TMS.js
./VirtualEarth.js
./WFS.js
./WMS.js
./Yahoo.js

Regards,
--
Christopher Schmidt
MetaCarta
_______________________________________________
Dev mailing list
[hidden email]
http://openlayers.org/mailman/listinfo/dev
Reply | Threaded
Open this post in threaded view
|

Re: NaturalDocs status

Paul Spencer-2
Added Layer/MapServer.js

I'll try to do the Untiled one too, but I have to get on a plane now.

Paul

On 28-Jun-07, at 7:34 AM, Christopher Schmidt wrote:

> On Thu, Jun 28, 2007 at 06:39:59AM -0400, Christopher Schmidt wrote:
>> On Thu, Jun 28, 2007 at 01:23:54AM -0500, Erik Uzureau wrote:
>>> Now a  total of 21 files left needing docs (and some needing  
>>> improved docs).
>>>  * Some Layer/* classes (17)
>>> * All of the Renderer/*, Renderer.js classes (4)
>>
>> I got renderer.js before I passed out last night, and it looks  
>> like Tim
>> got Renderer.VML and cleaned up our menus for us (yay).
>>
>> So:
>>  Some Layer/* classes
>>  Renderer/Elements.js
>>  Renderer/SVG.js
>
> Did a couple more layers. Of the Layer classes:
>
> Done:
> ./Boxes.js
> ./GeoRSS.js
> ./GML.js
> ./Image.js
> ./Markers.js
> ./Text.js
> ./Vector.js
> ./WMS/Untiled.js
> ./WorldWind.js
>
> Not done: (14)
> ./EventPane.js
> ./FixedZoomLevels.js
> ./Google.js
> ./Grid.js
> ./HTTPRequest.js
> ./KaMap.js
> ./MapServer/Untiled.js
> ./MapServer.js
> ./MultiMap.js
> ./TMS.js
> ./VirtualEarth.js
> ./WFS.js
> ./WMS.js
> ./Yahoo.js
>
> Regards,
> --
> Christopher Schmidt
> MetaCarta
> _______________________________________________
> Dev mailing list
> [hidden email]
> http://openlayers.org/mailman/listinfo/dev

+-----------------------------------------------------------------+
|Paul Spencer                          [hidden email]    |
+-----------------------------------------------------------------+
|Chief Technology Officer                                         |
|DM Solutions Group Inc                http://www.dmsolutions.ca/ |
+-----------------------------------------------------------------+





_______________________________________________
Dev mailing list
[hidden email]
http://openlayers.org/mailman/listinfo/dev
Reply | Threaded
Open this post in threaded view
|

Re: NaturalDocs status

Erik Uzureau-3
In reply to this post by Christopher Schmidt-2
Ill do the remaining renderer classes

On 6/28/07, Christopher Schmidt <[hidden email]> wrote:

> On Thu, Jun 28, 2007 at 01:23:54AM -0500, Erik Uzureau wrote:
> > Now a  total of 21 files left needing docs (and some needing improved docs).
> >  * Some Layer/* classes (17)
> > * All of the Renderer/*, Renderer.js classes (4)
>
> I got renderer.js before I passed out last night, and it looks like Tim
> got Renderer.VML and cleaned up our menus for us (yay).
>
> So:
>  Some Layer/* classes
>  Renderer/Elements.js
>  Renderer/SVG.js
>
> Leaving us at 19
>
> Regards,
> --
> Christopher Schmidt
> MetaCarta
>
_______________________________________________
Dev mailing list
[hidden email]
http://openlayers.org/mailman/listinfo/dev
Reply | Threaded
Open this post in threaded view
|

Re: NaturalDocs status

Erik Uzureau-3
I'll take the 3rd party layers (google, yahoo, ve)


On 6/28/07, Erik Uzureau <[hidden email]> wrote:

> Ill do the remaining renderer classes
>
> On 6/28/07, Christopher Schmidt <[hidden email]> wrote:
> > On Thu, Jun 28, 2007 at 01:23:54AM -0500, Erik Uzureau wrote:
> > > Now a  total of 21 files left needing docs (and some needing improved docs).
> > >  * Some Layer/* classes (17)
> > > * All of the Renderer/*, Renderer.js classes (4)
> >
> > I got renderer.js before I passed out last night, and it looks like Tim
> > got Renderer.VML and cleaned up our menus for us (yay).
> >
> > So:
> >  Some Layer/* classes
> >  Renderer/Elements.js
> >  Renderer/SVG.js
> >
> > Leaving us at 19
> >
> > Regards,
> > --
> > Christopher Schmidt
> > MetaCarta
> >
>
_______________________________________________
Dev mailing list
[hidden email]
http://openlayers.org/mailman/listinfo/dev
Reply | Threaded
Open this post in threaded view
|

Re: NaturalDocs status

Tim Schaub-2
Erik Uzureau wrote:
> I'll take the 3rd party layers (google, yahoo, ve)
>

I'll start on the non-3rd party layers that remain.  Alphabetically.

Tim
_______________________________________________
Dev mailing list
[hidden email]
http://openlayers.org/mailman/listinfo/dev
Reply | Threaded
Open this post in threaded view
|

Re: NaturalDocs status

Erik Uzureau-3
Ive just noticed that there are also missings from BaseTypes.js
ive just fixed ajax.js and will now fix basetypes.js.

then ill get to those layers.
e


On 6/28/07, Tim Schaub <[hidden email]> wrote:

> Erik Uzureau wrote:
> > I'll take the 3rd party layers (google, yahoo, ve)
> >
>
> I'll start on the non-3rd party layers that remain.  Alphabetically.
>
> Tim
> _______________________________________________
> Dev mailing list
> [hidden email]
> http://openlayers.org/mailman/listinfo/dev
>
_______________________________________________
Dev mailing list
[hidden email]
http://openlayers.org/mailman/listinfo/dev
Reply | Threaded
Open this post in threaded view
|

Re: NaturalDocs status

Erik Uzureau-3
Im on Layer.js

On 6/28/07, Erik Uzureau <[hidden email]> wrote:

> Ive just noticed that there are also missings from BaseTypes.js
> ive just fixed ajax.js and will now fix basetypes.js.
>
> then ill get to those layers.
> e
>
>
> On 6/28/07, Tim Schaub <[hidden email]> wrote:
> > Erik Uzureau wrote:
> > > I'll take the 3rd party layers (google, yahoo, ve)
> > >
> >
> > I'll start on the non-3rd party layers that remain.  Alphabetically.
> >
> > Tim
> > _______________________________________________
> > Dev mailing list
> > [hidden email]
> > http://openlayers.org/mailman/listinfo/dev
> >
>
_______________________________________________
Dev mailing list
[hidden email]
http://openlayers.org/mailman/listinfo/dev
Reply | Threaded
Open this post in threaded view
|

Re: NaturalDocs status

Erik Uzureau-3
Not done: (14)
./HTTPRequest.js
./KaMap.js
./MapServer/Untiled.js
Vector.js
./WFS.js



I'll take Kamap and then I think I'm going to bed.

--e


On 6/28/07, Erik Uzureau <[hidden email]> wrote:

> Im on Layer.js
>
> On 6/28/07, Erik Uzureau <[hidden email]> wrote:
> > Ive just noticed that there are also missings from BaseTypes.js
> > ive just fixed ajax.js and will now fix basetypes.js.
> >
> > then ill get to those layers.
> > e
> >
> >
> > On 6/28/07, Tim Schaub <[hidden email]> wrote:
> > > Erik Uzureau wrote:
> > > > I'll take the 3rd party layers (google, yahoo, ve)
> > > >
> > >
> > > I'll start on the non-3rd party layers that remain.  Alphabetically.
> > >
> > > Tim
> > > _______________________________________________
> > > Dev mailing list
> > > [hidden email]
> > > http://openlayers.org/mailman/listinfo/dev
> > >
> >
>
_______________________________________________
Dev mailing list
[hidden email]
http://openlayers.org/mailman/listinfo/dev
Reply | Threaded
Open this post in threaded view
|

Re: NaturalDocs status

Erik Uzureau-3
Ill do HTTPRequest too. what the hey

On 6/29/07, Erik Uzureau <[hidden email]> wrote:

> Not done: (14)
> ./HTTPRequest.js
> ./KaMap.js
> ./MapServer/Untiled.js
> Vector.js
> ./WFS.js
>
>
>
> I'll take Kamap and then I think I'm going to bed.
>
> --e
>
>
> On 6/28/07, Erik Uzureau <[hidden email]> wrote:
> > Im on Layer.js
> >
> > On 6/28/07, Erik Uzureau <[hidden email]> wrote:
> > > Ive just noticed that there are also missings from BaseTypes.js
> > > ive just fixed ajax.js and will now fix basetypes.js.
> > >
> > > then ill get to those layers.
> > > e
> > >
> > >
> > > On 6/28/07, Tim Schaub <[hidden email]> wrote:
> > > > Erik Uzureau wrote:
> > > > > I'll take the 3rd party layers (google, yahoo, ve)
> > > > >
> > > >
> > > > I'll start on the non-3rd party layers that remain.  Alphabetically.
> > > >
> > > > Tim
> > > > _______________________________________________
> > > > Dev mailing list
> > > > [hidden email]
> > > > http://openlayers.org/mailman/listinfo/dev
> > > >
> > >
> >
>
_______________________________________________
Dev mailing list
[hidden email]
http://openlayers.org/mailman/listinfo/dev
Reply | Threaded
Open this post in threaded view
|

Re: NaturalDocs status

Erik Uzureau-3
Im off to bed. Cant think anymore.

only three left:

./MapServer/Untiled.js
Vector.js
./WFS.js







On 6/29/07, Erik Uzureau <[hidden email]> wrote:

> Ill do HTTPRequest too. what the hey
>
> On 6/29/07, Erik Uzureau <[hidden email]> wrote:
> > Not done: (14)
> > ./HTTPRequest.js
> > ./KaMap.js
> > ./MapServer/Untiled.js
> > Vector.js
> > ./WFS.js
> >
> >
> >
> > I'll take Kamap and then I think I'm going to bed.
> >
> > --e
> >
> >
> > On 6/28/07, Erik Uzureau <[hidden email]> wrote:
> > > Im on Layer.js
> > >
> > > On 6/28/07, Erik Uzureau <[hidden email]> wrote:
> > > > Ive just noticed that there are also missings from BaseTypes.js
> > > > ive just fixed ajax.js and will now fix basetypes.js.
> > > >
> > > > then ill get to those layers.
> > > > e
> > > >
> > > >
> > > > On 6/28/07, Tim Schaub <[hidden email]> wrote:
> > > > > Erik Uzureau wrote:
> > > > > > I'll take the 3rd party layers (google, yahoo, ve)
> > > > > >
> > > > >
> > > > > I'll start on the non-3rd party layers that remain.  Alphabetically.
> > > > >
> > > > > Tim
> > > > > _______________________________________________
> > > > > Dev mailing list
> > > > > [hidden email]
> > > > > http://openlayers.org/mailman/listinfo/dev
> > > > >
> > > >
> > >
> >
>
_______________________________________________
Dev mailing list
[hidden email]
http://openlayers.org/mailman/listinfo/dev
Reply | Threaded
Open this post in threaded view
|

Re: NaturalDocs status

Erik Uzureau-3
by the way, there's something wrong with the OpenLayers.js file in the
naturaldocs
sandbox. i cant load any examples. too fried to debug it. maybe
someone throw an eye on it.

&out,
e


On 6/29/07, Erik Uzureau <[hidden email]> wrote:

> Im off to bed. Cant think anymore.
>
> only three left:
>
> ./MapServer/Untiled.js
> Vector.js
> ./WFS.js
>
>
>
>
>
>
>
> On 6/29/07, Erik Uzureau <[hidden email]> wrote:
> > Ill do HTTPRequest too. what the hey
> >
> > On 6/29/07, Erik Uzureau <[hidden email]> wrote:
> > > Not done: (14)
> > > ./HTTPRequest.js
> > > ./KaMap.js
> > > ./MapServer/Untiled.js
> > > Vector.js
> > > ./WFS.js
> > >
> > >
> > >
> > > I'll take Kamap and then I think I'm going to bed.
> > >
> > > --e
> > >
> > >
> > > On 6/28/07, Erik Uzureau <[hidden email]> wrote:
> > > > Im on Layer.js
> > > >
> > > > On 6/28/07, Erik Uzureau <[hidden email]> wrote:
> > > > > Ive just noticed that there are also missings from BaseTypes.js
> > > > > ive just fixed ajax.js and will now fix basetypes.js.
> > > > >
> > > > > then ill get to those layers.
> > > > > e
> > > > >
> > > > >
> > > > > On 6/28/07, Tim Schaub <[hidden email]> wrote:
> > > > > > Erik Uzureau wrote:
> > > > > > > I'll take the 3rd party layers (google, yahoo, ve)
> > > > > > >
> > > > > >
> > > > > > I'll start on the non-3rd party layers that remain.  Alphabetically.
> > > > > >
> > > > > > Tim
> > > > > > _______________________________________________
> > > > > > Dev mailing list
> > > > > > [hidden email]
> > > > > > http://openlayers.org/mailman/listinfo/dev
> > > > > >
> > > > >
> > > >
> > >
> >
>
_______________________________________________
Dev mailing list
[hidden email]
http://openlayers.org/mailman/listinfo/dev
Reply | Threaded
Open this post in threaded view
|

Re: NaturalDocs status

Christopher Schmidt-2
On Fri, Jun 29, 2007 at 02:29:42AM -0500, Erik Uzureau wrote:
> by the way, there's something wrong with the OpenLayers.js file in the
> naturaldocs
> sandbox. i cant load any examples. too fried to debug it. maybe
> someone throw an eye on it.

This was my fault -- a bad merge from trunk. I've reverted now, but this
means we'll need to do more work to figure out what exactly didn't work
in the merge before rolling it in.

Regards,
--
Christopher Schmidt
MetaCarta
_______________________________________________
Dev mailing list
[hidden email]
http://openlayers.org/mailman/listinfo/dev
Reply | Threaded
Open this post in threaded view
|

Re: NaturalDocs status

Christopher Schmidt-2
On Fri, Jun 29, 2007 at 05:51:12AM -0400, Christopher Schmidt wrote:
> On Fri, Jun 29, 2007 at 02:29:42AM -0500, Erik Uzureau wrote:
> > by the way, there's something wrong with the OpenLayers.js file in the
> > naturaldocs
> > sandbox. i cant load any examples. too fried to debug it. maybe
> > someone throw an eye on it.
>
> This was my fault -- a bad merge from trunk. I've reverted now, but this
> means we'll need to do more work to figure out what exactly didn't work
> in the merge before rolling it in.

Okay, the reason for this is that http://trac.openlayers.org/ticket/768
was applied to the branch, but not to trunk, and the OpenLayers.js
changed in trunk when I removed the Canvas layer, so we've got two
different modified versions. I'm not sure what the right way to go about
this is -- probably best to apply the namespace.patch to trunk, and then
work on manually integrating the docs into a trunk copy of OpenLayers.js,
and committing that.

However, that depends on someone reviewing #768: I don't have a strong
preference, but wanted someone else's eyes on it.

Regards,
--
Christopher Schmidt
MetaCarta
_______________________________________________
Dev mailing list
[hidden email]
http://openlayers.org/mailman/listinfo/dev
Reply | Threaded
Open this post in threaded view
|

Re: NaturalDocs status

Christopher Schmidt-2
In reply to this post by Erik Uzureau-3
On Fri, Jun 29, 2007 at 02:27:02AM -0500, Erik Uzureau wrote:
> Im off to bed. Cant think anymore.
>
> only three left:
>
> ./MapServer/Untiled.js
> Vector.js
> ./WFS.js

These are all in now.

Regards,
--
Christopher Schmidt
MetaCarta
_______________________________________________
Dev mailing list
[hidden email]
http://openlayers.org/mailman/listinfo/dev
12