I like the idea to generate parts of the website with stuff that comes
from the source code. However I can't see how the different sources
could all be assembled together. The sdk reference is already generated
from source, however that is already one step to far because we won't
get the styles right. So what we could do is to let the compiler
generate the XML documentation by using either the /doc or the /doc+
option. That XML could then further be transformed into website parts.
From a higher perspective I would also like to see all logging
subprojects to have one website style. Looking at the website of log4net
and log4j those projects appear to be unrelated, whereas the log4cxx and
log4j websites are more alike. Any ideas how we could achieve this?
On 2017-04-19 06:20, Remko Popma wrote:
Asciidoc is much nicer than anything one can do in javadoc.
Sent from my iPhone
On Apr 19, 2017, at 10:10, Gary Gregory <[email protected]> wrote:
Maybe from package level Javadocs?
Gary
On Apr 18, 2017 5:56 PM, "Remko Popma" <[email protected]> wrote:
Asciidoc can include code snippets or whole files:
http://asciidoctor.org/docs/user-manual/#include-partial
I'm not convinced that it's desirable to generate the user manual from
javadoc though. They usually target different audiences so the content is
different.
Sent from my iPhone
On Apr 19, 2017, at 9:03, Gary Gregory <[email protected]> wrote:
When I worked on my Hibernate book, we had a system that would extract
text
out of source files into the xhtml book source. All of the examples in
the
book come from real code that gets compiled and tested before the book is
built. So it is all doable.
Gary
On Apr 18, 2017 4:37 PM, "Matt Sicker" <[email protected]> wrote:
We have a similar issue in Log4j right now where documentation is mainly
maintained in the manual pages, but there are javadocs as well. Ideally,
I'd like to be able to generate the manual pages from the javadocs, but
I
haven't really looked into how to do that yet. I've seen such a pattern
used with other projects. Also, being able to compile and verify the
example code in the docs would also be good, but having those code
samples
be included straight from unit tests or test resources would be a good
way
to ensure both.
On 18 April 2017 at 10:16, Dominik Psenner <[email protected]> wrote:
Hi,
We probably should at least add a remark that points readers to the SDK
reference and avoid the double effort of maintaining the documentation
on
the website too.
Cheers,
Dominik
On 2017-04-18 17:09, Stefan Bodewig wrote:
Hi John
On 2017-04-18, John V wrote:
Please forward this if you are not the appropriate recipient.
Many thanks!
I was browsing the documentation on the Log4Net website for a list of
all of the formatting flags for the PatternLayout, but could not find
one. I did discover some dead links on the manual's introduction
page
at http://logging.apache.org/log4net/release/manual/
introduction.html
Under the Layouts heading none of the links seem to be valid.
It looks as if all the links to the API docs have been broken. I'll
look
into it, may take a few hours, though.
In the meantime, the docs are at
http://logging.apache.org/log4net/release/sdk/index.html -
PatternLayout
is
http://logging.apache.org/log4net/release/sdk/html/T_log4net
_Layout_PatternLayout.htm
Cheers
Stefan
--
Matt Sicker <[email protected]>
