[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Patch-gnuradio] Doxygen Enhancements
From: |
Firas Abbas |
Subject: |
Re: [Patch-gnuradio] Doxygen Enhancements |
Date: |
Fri, 2 Jan 2009 01:23:26 -0800 (PST) |
Hi,
To reflect the new changes to the trunk (New USRP C++ API), I modified my
doxygen patch to the trunk. The new patch can be found at:
http://rapidshare.com/files/178950756/doxygen.diff
A sample of the new doxygen generated documentation using this patch can be
found at:
http://rapidshare.com/files/178946897/New_doxygen_generated_html.tar.bz2
I have new source documentation patches for blks2 waiting to be applied after
applying above doxygen patches.
Best Regards,
Firas
--- On Sat, 12/6/08, Firas Abbas <address@hidden> wrote:
> From: Firas Abbas <address@hidden>
> Subject: [Patch-gnuradio] Doxygen Enhancements
> To: address@hidden
> Date: Saturday, December 6, 2008, 10:26 PM
> Hi,
>
> I did some work to enhance gnuradio doxygen generated
> documentation. The work includes :
>
> 1) Enabling Tree view (very useful).
>
> 2) Current Gnuradio documentation had problems when
> generating python using doxygen + doxypy.py. The problem is
> that if we want to keep the code docstring we will not be
> able to generate the required documentation using the above
> tool combinations. I emailed the creator of doxypy and
> explained the problem to him. He modified his doxypy code to
> solve this problem. Now, the new doxypy.py is working
> perfectly with doxygen without the need to do any gnuradio
> source code modifications.
>
> 3) The complete source code (*.h, *.cc and *.py) now
> included in the generated doxygen documentation. I think
> this is useful to examine class implentation directly in
> case the written documenation is poor.
>
> 4) All the class are sorted alphabetically.
>
>
>
> Dear gnuradio Administrators,
>
> I hope from you to apply this patch as quick as possible,
> because I have about 8 work-off days, and I'm planning
> to invest this time to enhance gnuradio source files
> documentation.
>
>
>
> The patch (new doxypy.py + new Doxyfile.in) can be found
> at:
>
> http://rapidshare.com/files/170887092/new_doxygen.diff
>
>
> Best Regards,
>
>
> Firas
>
>
>
> _______________________________________________
> Patch-gnuradio mailing list
> address@hidden
> http://lists.gnu.org/mailman/listinfo/patch-gnuradio
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- Re: [Patch-gnuradio] Doxygen Enhancements,
Firas Abbas <=