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]> >
