I second this whole thing, i'll help documenting some stuff
Maybe it will increase the sharing of ideas/code with the sdk -- i.e.
people not keeping everything to themselves.
Adam Maras (memzero) wrote:
My thinking is that we'll have more people interested in modding if they
see that the Orange Box SDK is out and has decent documentation.
// Adam Maras (memzero)
Paul Peloski wrote:
--
[ Picked text/plain from multipart/alternative ]
I'd help in a community effort to clean up and document SDK code. It
would
have to be in the form of a patch, since it's illegal to redistribute
the
actual SDK. The only problem is that it's a little late to start on an
effort like that, considering most HL2 mods are already started since
the
SDK has been out for quite a while.
Regards,
Paul
On Dec 28, 2007 4:38 PM, Jed <[EMAIL PROTECTED]> wrote:
Where Doxygen is most useful is when the actual code itself is
commented in a way that makes documenting easier and theres where
we're stuck. Im not sure what convention Valve uses but Doxygen
doesn't like it.
To be honest, the most benefitial thing to do would be to go through
the entire code base and comment/note properly everything in the
source then running Doxygen is just a trivial process. Of course thats
time consuming and would need a major shift of practice from Valve.
- Jed
On 28/12/2007, Tom Leighton <[EMAIL PROTECTED]> wrote:
There is an option within Doxygen to include the whole source tree,
just
certain sections (For documented classes/functions), or none at all.
I'm guessing we wouldn't use the first one, maybe the second or third.
Adam Maras (memzero) wrote:
You have no idea how happy I am to hear that :D
That being said, was there ever really a _proper_ documentation site
written for the SDK? The only reason I'm not saying we should do it
now
is because the Orange Box code is on the verge of release... it would
be
foolish to start documenting only to find changed.
// Adam Maras (memzero)
Garry Newman wrote:
I don't think that much has changed internally to warrant this burst
of action. It's just really the same code, cleaned up, with
new/changed bits. A conversion guide would probably be good though.
Although I think there's only really about 5 major things that you'd
need to change in your code.
garry
On Dec 28, 2007 7:00 PM, Adam Maras (memzero)
<[EMAIL PROTECTED]> wrote:
That's another reason a manual writeup might be a good idea. We
don't
have to post the source tree, just class definitions and such.
// Adam Maras (memzero)
Jed wrote:
Theres already a hundred odd sites with Doxygen dumps of the HL2
SDK.
That said, putting the code through Doxygen not only documents it
but
will also give access to the entire source tree. Considering that
you
have to buy a Source game to get access to the SDK, this kind
bypasses
it.
- Jed
On 28/12/2007, Tom Leighton <[EMAIL PROTECTED]> wrote:
Could VALVe possibly host a Doxygen'd site for us of the SDK
code?
Then
we can link to it from the WIKI.
Tobias Kammersgaard wrote:
--
[ Picked text/plain from multipart/alternative ]
Interesting idea! A Doxygen setup perhaps :-)?
/ProZak
On 28/12/2007, Adam Maras (memzero) <[EMAIL PROTECTED]>
wrote:
Hello everybody,
As Mike Durand said, it doesn't look likely that the SDK code
for the
Orange Box is going to be out by the end of the month. That
being said,
we have some time to get ready for it! I'm proposing that once
the code
is release, myself and some of you people out there in
coderland
get
together to discuss documenting the code. By documenting, of
course, I'm
talking about making some HTML or wiki pages with things like
class
definitions, function purposes, inheritance diagrams, etc...;
all the
stuff that a commercial project would have documented. This
way,
there
might be more people interested in Source modding, since
there's
more
documentation around. I'll say this-- the Source source scares
me a
little bit! Probably just because I don't have enough docs on
it.
Anyone interested?
// Adam Maras (memzero)
_______________________________________________
To unsubscribe, edit your list preferences, or view the list
archives,
please visit:
http://list.valvesoftware.com/mailman/listinfo/hlcoders
--
_______________________________________________
To unsubscribe, edit your list preferences, or view the list
archives, please visit:
http://list.valvesoftware.com/mailman/listinfo/hlcoders
_______________________________________________
To unsubscribe, edit your list preferences, or view the list
archives, please visit:
http://list.valvesoftware.com/mailman/listinfo/hlcoders
_______________________________________________
To unsubscribe, edit your list preferences, or view the list
archives, please visit:
http://list.valvesoftware.com/mailman/listinfo/hlcoders
_______________________________________________
To unsubscribe, edit your list preferences, or view the list
archives, please visit:
http://list.valvesoftware.com/mailman/listinfo/hlcoders
_______________________________________________
To unsubscribe, edit your list preferences, or view the list
archives, please visit:
http://list.valvesoftware.com/mailman/listinfo/hlcoders
_______________________________________________
To unsubscribe, edit your list preferences, or view the list
archives,
please visit:
http://list.valvesoftware.com/mailman/listinfo/hlcoders
_______________________________________________
To unsubscribe, edit your list preferences, or view the list archives,
please visit:
http://list.valvesoftware.com/mailman/listinfo/hlcoders
_______________________________________________
To unsubscribe, edit your list preferences, or view the list archives,
please visit:
http://list.valvesoftware.com/mailman/listinfo/hlcoders
--
_______________________________________________
To unsubscribe, edit your list preferences, or view the list
archives, please visit:
http://list.valvesoftware.com/mailman/listinfo/hlcoders
_______________________________________________
To unsubscribe, edit your list preferences, or view the list archives,
please visit:
http://list.valvesoftware.com/mailman/listinfo/hlcoders
_______________________________________________
To unsubscribe, edit your list preferences, or view the list archives, please
visit:
http://list.valvesoftware.com/mailman/listinfo/hlcoders
