Re: [g-a-devel] gnome-mag CORBA API documentation

[Bill Haneman <Bill Haneman Sun COM>]

Carlos:

Thanks very much for your offer to help document the gnome-mag API.  
We're planning to use doxygen to generate API documentation from the 
IDL.  Thus, everything in the file "GNOME_Magnifier.idl" is public API 
and should be documented via the doxygen comment techniques.

This includes GNOME_Magnifier_Point, GNOME_Magnifier_RectBounds, 
GNOME_Magnifier_ZoomRegion_AlignPolicy, 
GNOME_Magnifier_ZoomRegion_ScrollingPolicy,  
GNOME_Magnifier_ZoomRegionList, as well as the methods you list below.

The methods associated with IDL attributes should be documented by 
documenting the attributes directly; you should not create documentation 
for "__get_SourceDisplay", etc.

Please see the recent IDL tarball posted at 
gnome.org/~billh/at-spi-new-idl/idl.tar.gz, and the documentation 
generated from this IDL at gnome.org/~billh/at-spi-new-idl/html/html/
for examples of how to use doxygen comments to document IDL.

Again, thanks very much!

Bill

Carlos Eduardo Rodrigues Diogenes wrote:

> Hi Bill,
>
> I'm trying to indentify all the methods that can be called by other 
> application to communicate with gnome-mag throw CORBA to document 
> then. I find these:
>
>     * GNOME_Magnifier_Magnifier__get_SourceDisplay()
>     * GNOME_Magnifier_Magnifier__get_TargetDisplay()
>     * GNOME_Magnifier_Magnifier__set_SourceDisplay()
>     * GNOME_Magnifier_Magnifier__set_TargetDisplay()
>     * GNOME_Magnifier_Magnifier_addZoomRegion()
>     * GNOME_Magnifier_Magnifier_clearAllZoomRegions()
>     * GNOME_Magnifier_Magnifier_createZoomRegion()
>     * GNOME_Magnifier_Magnifier_dispose()
>     * GNOME_Magnifier_Magnifier_getProperties()
>     * GNOME_Magnifier_Magnifier_getZoomRegions()
>     * GNOME_Magnifier_ZoomRegion_dispose()
>     * GNOME_Magnifier_ZoomRegion_getMagFactor()
>     * GNOME_Magnifier_ZoomRegion_getProperties()
>     * GNOME_Magnifier_ZoomRegion_getROI()
>     * GNOME_Magnifier_ZoomRegion_markDirty()
>     * GNOME_Magnifier_ZoomRegion_moveResize()
>     * GNOME_Magnifier_ZoomRegion_setMagFactor()
>     * GNOME_Magnifier_ZoomRegion_setROI()
>
> There are others? There is any method that is used to comunicate with 
> gnome-mag that don't use CORBA?
>
> Thanks,
> Carlos.
> _______________________________________________
> Gnome-accessibility-devel mailing list
> Gnome-accessibility-devel gnome org
> http://mail.gnome.org/mailman/listinfo/gnome-accessibility-devel