Re: [Discuss-gnuradio] Enhancing Gnuradio Doxygen Generated Official Documentation

[Firas A.]

Hi Eric,

kindly, I have a question about the possibility to make the documentation
changes to svn source files. 
Let us suppose that I started today to do the new documentation with rev
4796. And let us assume that I will finish the documentation in 15 days.

What may be happen in these 15 days, is that the files that has been updated
with a new documentation could be changed by the daily continuous developing
process. And in these 15 days, we may found our selfs have to download the
new files and add to them the new documentation and this may never end.

I think we should upload daily the documentation changes to the truck and
not to wait until all has been finished.

Best Regards,

Firas

Eric Blossom wrote:
> 
> On Mon, Dec 17, 2007 at 11:15:21AM -0800, Firas A. wrote:
>> 
>> Dear Eric,
>> 
>> 1) The complete attachments (files) for the new modifications are :
>> 
>> http://rapidshare.com/files/76826593/gnuradio-html-documentation.tar.gz
>> http://rapidshare.com/files/77243364/newdoc.tar.gz
>> 
>> 
>> 2) The differences between original (Doxyfile.in, group_defs.dox) and the
>> modified one (main_page.dox was not modified) are  :
>> 
>> http://rapidshare.com/files/77248944/differences.tar.gz
>> 
>> Best Regards,
>> 
>> Firas
> 
> Firas, I've applied a minor variation on your patches to the trunk as
> of r7445.  I may have inadvertantly changed some of the EXCLUDE stuff,
> please feel free to send patches as you see fit.
> 
> Everyone, these changes allow doxygen to generate unified output
> that includes both the C++ classes and the Python classes.  There's
> still plenty of work to be done, but this is a great start.
> 
> For those who would like to help clean up the doxygen generated
> documentation, the easiest way is to submit patches against the trunk.
> To do that, check out the svn trunk:
> 
>   $ svn co http://gnuradio.org/svn/gnuradio/trunk
> 
> and bootstrap and configure
> 
>   $ cd trunk
>   $ ./bootstrap
>   $ ./configure --enable-doxygen    # be sure to use this, otherwise no
> docs
>   $ make
> 
> When it's done, point your browser at
> 
>   file:///ABSOLUTE_PATH_TO/gnuradio-core/doc/html/index.html
> 
> Look at the output,  edit to your heart's content, and repeat until
> docs are improved ;)
> 
> When you're happy, generate a patch using  
> 
>   $ svn diff > my_doc_fixes.patch
> 
> Be sure to look through the patch to ensure that it only contains 
> things that you mean to go in.  Then mail the patch file to
> address@hidden  You'll have to subscribe first.
> 
> Looking forward to seeing our improved docs!
> 
> Eric
> 
> 
> _______________________________________________
> Discuss-gnuradio mailing list
> address@hidden
> http://lists.gnu.org/mailman/listinfo/discuss-gnuradio
> 
> 

-- 
View this message in context: 
http://www.nabble.com/Re%3A--Patch-gnuradio--Enhancing-Gnuradio-Doxygen-Generated-Official-Documentation-tp14366456p15049604.html
Sent from the GnuRadio mailing list archive at Nabble.com.