[Mapbender-dev] JSDoc (was: JSDoc and compression)

[Christoph Baudson (WhereGroup)]

For the upcoming release I want to prepare JSDoc for the following files

geometry.js
map.js
point.js
map_obj.js

The documentation is of course not complete, as some parts are 
undergoing a redesign. But a lot of classes are already fully documented.

With this API, programming will be much more efficient. At least I hope so.

The output of JSDoc is HTML only. There is no Wiki output. So where will 
the files be put?


Christoph Baudson (WhereGroup) schrieb:
> I guess JSDoc is a good choice; maybe we should adopt it as well, as it 
> is very similar to the PHPDoc Marc introduced. Any objections?
> 
> With the introduction of JS-documentation packing or comment-stripping 
> becomes inevitable to keep traffic at a minimum. The OpenLayers project 
> is very clever about this, as they allow you to switch back and forth 
> from a single compressed file to a developer version with multiple files 
> and comments (Paul Spencer mentioned that in a previous post).
> 
> I think we will have to learn how to do this too. It doesn't seem to be 
> too difficult.
> 
> Christoph
> 
> Christoph Baudson (WhereGroup) schrieb:
>>> Did we agree on how to document and comment JavaScript-Code? I forgot.
>>
>> How about this one? http://jsdoc.sourceforge.net/
>>
>> This is what the OpenLayers project uses as well.
>>
>> -- 
>> Baudson Christoph
>> http://www.wheregroup.com
>> _______________________________________________
>> Mapbender_dev mailing list
>> Mapbender_dev at lists.osgeo.org
>> http://lists.osgeo.org/mailman/listinfo/mapbender_dev
> 
> -- 
> Baudson Christoph
> http://www.wheregroup.com
> _______________________________________________
> Mapbender_dev mailing list
> Mapbender_dev at lists.osgeo.org
> http://lists.osgeo.org/mailman/listinfo/mapbender_dev