Re: [sk-develop] Compiler bugs are fixed

[Radoslaw M. <rad...@gm...>]

Hi,

Yea, I just took a look - way too much chaff in those module files when we
include documentation. 

Whenever I get a chance, I'll move the doc strings to a separate
texinfo-based file (or collection of files). Probably also add a section to
the makefile to give users the possibility of generating HTML/PDF from the
texinfo source.

Cheers-
  -Radek



-----Original Message-----
From: Martin Kalbfuß [mailto:ma....@we...] 
Sent: Monday, December 14, 2009 5:57 PM
To: sch...@li...
Subject: [sk-develop] Compiler bugs are fixed

The compiler bugs are fixed now. The project is compilable again.
I started to add docstrings to the SKVideo module. But I'm not really
happy with the result. Maybe this was a bad idea.
The docstrings are equal to the SDL documentation entries. Except some
changed names and parts which looked unnecessary.

The problem is, that some docstrings are so big, that they make the
definition module unreadable.

Maybe it's better to keep the documentation separate from the code. 
But you can use this docstrings as basis for the documentation.
Maybe you have an idea.


----------------------------------------------------------------------------
--
Return on Information:
Google Enterprise Search pays you back
Get the facts.
http://p.sf.net/sfu/google-dev2dev
_______________________________________________
Schwarzerkaffee-develop mailing list
Sch...@li...
https://lists.sourceforge.net/lists/listinfo/schwarzerkaffee-develop