Hi,
during the docs review I noticed that the Spring approach is well documented,
the way classes interact with each other in the context less. For example,
what are the beans, and their extension points thru the context (that is, for
which interfaces the do look for).
I believe this is important in order to extend Geoserver with new functionality,
yet not very clear.
I believe something like the output of beandoc
(http://opensource.atlassian.com/confluence/spring/display/BDOC/Home)
along with some comments should fix this problems:
- the dependencies should be clear from the generated diagrams
- the "extension points", that is, the interfaces looked for in order to get up
"plugin" functionality need to be documented by hand I fear.
Plus, making this tool work with maven is not a piece of cake, neither is making
it work with context files having all the same names
Cheers
Andrea
Andrea Aime ha scritto:
Hi,
during the docs review I noticed that the Spring approach is well documented,
the way classes interact with each other in the context less. For example,
what are the beans, and their extension points thru the context (that is, for
which interfaces the do look for).
I believe this is important in order to extend Geoserver with new functionality,
yet not very clear.
I believe something like the output of beandoc
(http://opensource.atlassian.com/confluence/spring/display/BDOC/Home)
along with some comments should fix this problems:
- the dependencies should be clear from the generated diagrams
Oh, btw, attached you'll find the diagram generated by using beandoc "by hand", that is,
without maven integration.
If you want to see a sample of what beandoc does, here:
http://springframework.sourceforge.net/beandoc/jpetstore/
Cheers
Andrea
(attachments)
Cool diagram, quite useful, thanks Andrea.
In terms of a "documentation roadmap" I think once we get over the hurdles of "the simple plugin" and "the simple app" we can move onto a more complete reference, in which we document which interfaces are used as extension points.
-Justin
Andrea Aime wrote:
Andrea Aime ha scritto:
Hi,
during the docs review I noticed that the Spring approach is well documented,
the way classes interact with each other in the context less. For example,
what are the beans, and their extension points thru the context (that is, for
which interfaces the do look for).
I believe this is important in order to extend Geoserver with new functionality,
yet not very clear.
I believe something like the output of beandoc
(http://opensource.atlassian.com/confluence/spring/display/BDOC/Home)
along with some comments should fix this problems:
- the dependencies should be clear from the generated diagrams
Oh, btw, attached you'll find the diagram generated by using beandoc "by hand", that is,
without maven integration.
If you want to see a sample of what beandoc does, here:
http://springframework.sourceforge.net/beandoc/jpetstore/
Cheers
Andrea
!DSPAM:1004,44919136102621116498154!
------------------------------------------------------------------------
------------------------------------------------------------------------
!DSPAM:1004,44919136102621116498154!
------------------------------------------------------------------------
_______________________________________________
Geoserver-devel mailing list
Geoserver-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/geoserver-devel
!DSPAM:1004,44919136102621116498154!
--
Justin Deoliveira
jdeolive@anonymised.com
The Open Planning Project
http://topp.openplans.org