Yeah, honestly, though it'd be a big change, it'd be a one-time thing to synch up and then you don't worry about it anymore except for comments/docs near code that's changing anyway.
And yeah, ain't no one pay attention to the wiki unless they want to use it as a source for an article. My non-coder thoughts. >>On Tue, Aug 23, 2011 at 4:32 AM, uwe koch <spiro...@gmx.net> wrote: >>> On 22.08.2011 11:12, Thilo Schulz wrote: > >>> A patch would leave no piece of code untouched, this is a nightmare >>> from the >>> point of view of someone who regularly merges ioquake3 changes to his >>> project. > > Every ioq3 fork that I have seen is already a nightmare. I don't > think people are worried about making it easy to keep in sync. What > happened to that hg/git discussion over a year ago? > >> The documentation can live in seperate files, it doesn't have to be >> mingled with the code. > > The code and documentation should be mingled. Otherwise, it will get > out of sync. Additionally, you cannot generate as good of > documentation without modifying the code. Tools like doxygen are > designed to figure out as much of the structure and content of your > code as possible along with your manually entered comments. > >> I think the main problem is getting people to contribute. The code >> overview pages in the ioquake3 wiki are in bad shape because of lacking >> contributions, even tough editing a wiki page is dead easy. Compare that >> to the process of formatting your documentation in javadoc syntax, >> creating a patch file, filing it to bugzilla and having someone commit >> it. > > I don't want to edit a wiki because it can get out of sync with the > code. It's better having it along side the code. When people update > the code, they can fix any documentation that was impacted. > > If ioquake3 was using hg/git, end users could add documentation easily > and tell the ioquake3 developers to pull the changes. > >> In case this takes off, (as a fork, for starters?) I'd be happy to merge >> the stuff from http://soclose.de/q3doc/ > > Never heard of this. Thanks. > _______________________________________________ > ioquake3 mailing list > ioquake3@lists.ioquake.org > http://lists.ioquake.org/listinfo.cgi/ioquake3-ioquake.org > By sending this message I agree to love ioquake3 and libsdl. > _______________________________________________ ioquake3 mailing list ioquake3@lists.ioquake.org http://lists.ioquake.org/listinfo.cgi/ioquake3-ioquake.org By sending this message I agree to love ioquake3 and libsdl.
