Corne, I'm interested in seeing that code you have, thanks. Development documentation isn't meant to be accurate up to the latest revision. That's almost impossible. It doesn't have to be the Holy Grail of information for the project. But what it should provide is a good starting point for new developers. Of course the source code is the best place to get data on what the software is actually doing, but it's not the best for brand new people who wish to contribute to a project. I haven't been in this industry very long but so far most of the software projects I've worked on were either sufficiently documented or I had personal access to developers. There were meetings and architectural descussions prior to me seeing one line of code. The idea is not to make you an expert on every corner of the project, but rather have you start making changes with a great deal more context.
-Chris -----Original Message----- From: Corne Beerse [mailto:[EMAIL PROTECTED] Sent: Monday, March 03, 2008 3:56 AM To: Williams, Chris (Marlboro) Cc: vnc-list@realvnc.com Subject: Re: How to understand VNC executing sequence Williams, Chris (Marlboro) wrote: > That's not developer documentation. Do you not know what developer > documentation is? > I'm talking about everything from high level flow charts down to > detailed annotated source code listings. > Descriptions of functions, what they do and why. Files, modules, data > types, etc. Style guides, APIs and library docs. Development history, > authors and contacts. > All presented to a new developer in a persistent, organized manner. > Well, from my experience as a professional software developer (some years ago) I can tell you that the only documentation that is always accurate, up-to-date, complete, structured and 'readable', is the source code. All other documentation is either not-existing, outdated, incomplete or otherwise not that useful. For what its worth and as far as I know (vnc 3.7 knowledge), the Xvnc server is a combination of an X11 server (Xfree or Xorg or such, I donnot know the current status) and a vnc display driver. For the X11 part, expect only the required parts to be used. For the documentation on that part, see there. For the vnc part of the implementation, I've sent some example code that puts up a counter or a clock in a vnc-session. That was part of the old vnc documentation, if someone is interested and it cannot be found on a webpage, I'm happy to send it. > Something like this: > http://developer.mozilla.org/en/docs/Code_snippets:Tabbed_browser > Or this: > http://www.x.org/wiki/PciReworkProposal > Or this: > http://library.gnome.org/devel/libgnome/stable/libgnome-gnome-program.ht > ml > > This is all basic documentation for new developers getting involved in > existing projects. Telling someone to read raw source files at the mere > mention of development assistance is tantamount to summary dismissal. > > -Chris > _______________________________________________ VNC-List mailing list VNC-List@realvnc.com To remove yourself from the list visit: http://www.realvnc.com/mailman/listinfo/vnc-list
