tomee-users mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Alex Soto <asot...@gmail.com>
Subject Re: TomEE Maven Plugin Documentation
Date Sun, 27 Jul 2014 10:07:21 GMT
Well I was thinking not in the whole Apache TomEE but in for example Maven
plugin, Arquillian and these ecosystem tools


2014-07-27 12:05 GMT+02:00 Romain Manni-Bucau <rmannibucau@gmail.com>:

> Hi
>
> this page is simply generated as any mojo page then pasted in the html
> page to match our template (sure we can change default template to
> make it one step).
>
> IMO docstract or more generally doc in code doesn't work cause you
> don't use tomee as a lib but as a framework so you don't want to look
> where but only how.
>
>
> Romain Manni-Bucau
> Twitter: @rmannibucau
> Blog: http://rmannibucau.wordpress.com/
> LinkedIn: http://fr.linkedin.com/in/rmannibucau
> Github: https://github.com/rmannibucau
>
>
> 2014-07-27 10:52 GMT+02:00 Alex Soto <asotobu@gmail.com>:
> > Hi guys,
> >
> > I have seen another page which is outdated as well. This is the TomEE
> Maven
> > Plugin  - Optional Parameters section.
> >
> > For example there is no information for context parameter, which in fact
> it
> > is available in Mojo.
> >
> https://github.com/apache/tomee/blob/trunk/maven/tomee-maven-plugin/src/main/java/org/apache/openejb/maven/plugin/AbstractTomEEMojo.java#L163
> >
> > I don't know where I should modify this page, I have no problem to update
> > it but because I know that cannot be modified directly I don't know where
> > to do it.
> >
> > I think that we should talk about how to improve the documentation in the
> > sense that it doesn't get outdated. For example I am using docstract
> > https://github.com/lordofthejars/docstract of course it is only a
> > possibility, you need to update the documentation as well but at least
> > documentation and source code are at the same class which maybe it is
> easy
> > to keep it updated.
> >
> > Well it is only an idea of course.
> >
> > Alex.
> >
> > --
> > +----------------------------------------------------------+
> >   Alex Soto Bueno
> >   www.lordofthejars.com
> > +----------------------------------------------------------+
>



-- 
+----------------------------------------------------------+
  Alex Soto Bueno - Computer Engineer
  www.lordofthejars.com
+----------------------------------------------------------+

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message