This reminds me of an idea I had lately. A custom Doclet (I think that's what it's called) we can use to generate our site documentation from so that we can centralize docs into javadocs for the most part. It's something I'd like to investigate to see how feasible it is, but it might be nice to use rather normal javadocs to explain the various plugins and such, and then have the manual be generated from the summaries and such. As a developer, I tend to prefer looking at javadocs for the lower level details, and a manual for the high level concepts and architecture ideas. Making documentation appear in more than one place without duplicating it manually and all the problems that come from that would be great.
On 17 September 2014 05:16, Remko Popma <[email protected]> wrote: > There's a new Jira for this now: > https://issues.apache.org/jira/browse/LOG4J2-833 > > Patches welcome! :-) > > Sent from my iPhone > > On 2014/09/17, at 19:08, Mikael Ståldal <[email protected]> > wrote: > > I guess that most Log4j users are not going to read the comments in the > POM. > > On Wed, Sep 17, 2014 at 3:34 AM, Matt Sicker <[email protected]> wrote: > >> We'd certainly like to improve this in the documentation and have been >> discussing it recently. I made sure to add a bunch of comments (which >> inspired others to do the same afterward) to the pom file to note what each >> dependency was used for. >> >> On 16 September 2014 02:39, Mikael Ståldal < >> [email protected]> wrote: >> >>> log4j-core has quite some Maven dependencies declared >>> with <optional>true</optional>. E.g. Jackson. >>> >>> Is that really wise? I see a risk that users of Log4j is not aware if >>> this and will get ClassNotFoundException:s at runtime. >>> >>> >>> http://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html >>> >>> -- >>> Mikael Ståldal >>> Chief Software Architect >>> *Appear* >>> Phone: +46 8 545 91 572 >>> Email: [email protected] >>> >> >> >> >> -- >> Matt Sicker <[email protected]> >> > > > > -- > Mikael Ståldal > Chief Software Architect > *Appear* > Phone: +46 8 545 91 572 > Email: [email protected] > > -- Matt Sicker <[email protected]>
