Hello I commented to the example snippet issue in another mail.
On Wed, 18 Nov 2009 19:20:02 -0600 Curt Arnold <[email protected]> wrote: ... > > Else, if you have the time for it, that would indeed be great. If > > not I > > would risk bringing this issue up on the IPMC and if it gets rejected > > just cut & paste into the phpdoc as well as into the .apt files. > > > > The API is rock solid and with the low development on log4j will > > probably stay that way anytime soon and if we have 1-2 bugs in the > > examples than let it be that way and users can file a bug for it. > > > > Did you intend to say "log4j"? If so, how is that relevant. IMHO the log4php is a port of log4j to have a cross language logging API as many PHP developers are using Java as well. So it should not drift away too much from its sister project(s). Also as log4j is around for a long time, having a low development seems to indicate that the current API is good enough. So I don't assume that the log4php API will change much in the next years. But that was only a guess to justify putting the examples back into the phpdoc as I originally extracted them from there to be able to automatically check them for syntax errors. But a unit test for examples didn't turn out to be as easy as I thought. > >> Since the generated docs could depend on the version of phpdoc > >> installed, I think it would be good to disclose the environment that > >> is used to build the release packages. Ideally a clean fresh > >> installed OS on an VM with just the minimum installed packages. > > > > I'm not sure how you mean that (writing the version numbers to a > > README or Wiki or somehow specifying it in maven?) but Christian G. > > seems already to have a plan :) > > > > bye, > > > > -christian- > > A log4j distribution has a lot more binary artifacts than I'd expect > log4php to have, so it is more beneficial to know the build > environment in case you want to check that it can be reproduced or to > create a bug release version that is as close as possible to the > original. > https://svn.apache.org/repos/asf/logging/log4j/trunk/BUILD-INFO.txt > is a little dated example from log4j. Ah, so you really meant just a README file. I second that :) bye, -christian-
