Ticket #1: ddoc-atk-gda-gdk-pixbuf-gld-glib.diff

File ddoc-atk-gda-gdk-pixbuf-gld-glib.diff, 12.2 kB (added by Mike Wey, 1 year ago)

DDoc in APILookup[Atk | Gda | Gdk | GdkPixbuf? | Gld | Gilb].txt

  • gtkD/wrap/APILookupGda.txt

    old new  
    114114 
    115115    /** 
    116116     * Initializes the GDA library. 
    117      * app_id : 
    118      *  name of the program. 
    119      * version : 
    120      *  revision number of the program. 
    121      * args : 
    122      *   args from main(). 
     117     * Params: 
     118     *  appId = name of the program. 
     119     *  version = revision number of the program. 
     120     *  args = args from main(). 
    123121     */ 
    124122    public static void init(char[] appId, char[] versio, char[][] args) 
    125123    { 
    …… 
    177175     * specify GDA_CONNECTION_OPTIONS_DONT_SHARE as one of the flags in 
    178176     * the options parameter. 
    179177     * This function is the way of opening database connections with libgda. 
    180      * client : 
    181      *  a GdaClient object. 
    182      * dsn : 
    183      *  data source name. 
    184      * username : 
    185      *  user name. 
    186      * password : 
    187      *  password for username. 
    188      * options : 
    189      *  options for the connection (see GdaConnectionOptions). 
     178     * Params: 
     179     *  dsn = data source name. 
     180     *  username = user name. 
     181     *  password = password for username. 
     182     *  options = options for the connection (see GdaConnectionOptions). 
    190183     * Returns : 
    191184     *  the opened connection if successful, NULL if there is 
    192      * an error. 
     185     *  an error. 
    193186     */ 
    194187    public Connection openConnection(char[] dsn, char[] username, char[] password, GdaConnectionOptions options) 
    195188    { 
    …… 
    250243import: glib.ListG 
    251244import: std.string 
    252245code: start 
     246    /** */ 
    253247    this (ListG glist) { 
    254248        this.gdaDataSourceInfo = cast(GdaDataSourceInfo *) glist.data; 
    255249    } 
     250    /** */ 
    256251    char[] name() { return std.string.toString(this.gdaDataSourceInfo.name); } 
     252    /** */ 
    257253    char[] provider() { return std.string.toString(this.gdaDataSourceInfo.provider); } 
     254    /** */ 
    258255    char[] cncString() { return std.string.toString(this.gdaDataSourceInfo.cncString); } 
     256    /** */ 
    259257    char[] description() { return std.string.toString(this.gdaDataSourceInfo.description); } 
     258    /** */ 
    260259    char[] username() { return std.string.toString(this.gdaDataSourceInfo.username); } 
     260    /** */ 
    261261    char[] password() { return std.string.toString(this.gdaDataSourceInfo.password); } 
    262262         
    263263code: end 
    …… 
    277277import: glib.ListG 
    278278import: std.string 
    279279code: start 
     280    /** */ 
    280281    this (ListG glist) { 
    281282        this.gdaProviderInfo = cast(GdaProviderInfo *) glist.data; 
    282283    } 
     284    /** */ 
    283285    char[] id() { return std.string.toString((cast(_GdaProviderInfo*)this.gdaProviderInfo).id); } 
     286    /** */ 
    284287    char[] location() { return std.string.toString((cast(_GdaProviderInfo*)this.gdaProviderInfo).location); } 
     288    /** */ 
    285289    char[] description() { return std.string.toString((cast(_GdaProviderInfo*)this.gdaProviderInfo).description); } 
     290    /** */ 
    286291    ListG gda_params() { return new ListG((cast(_GdaProviderInfo*)this.gdaProviderInfo).gda_params); } 
    287      
    288          
    289292code: end 
    290293 
    291294outFile: ProviderInfo 
    …… 
    342345import: gda.Value 
    343346 
    344347code: start 
     348    /** */ 
    345349    this (ListG glist) { 
    346350        this.gdaDataModel = cast(GdaDataModel *) glist.data; 
    347351    } 
    348  
    349352code: end 
    350353outFile: DataModel 
    351354 
    …… 
    358361import: glib.ListG 
    359362 
    360363code: start 
     364    /** */ 
    361365    this (ListG glist) { 
    362366        this.gdaError = cast(GdaError *) glist.data; 
    363367    } 
    364  
    365368code: end 
    366369outFile: Error 
    367370 
    …… 
    523526nocode: gda_value_new_uinteger 
    524527 
    525528code: start 
     529    /** */ 
    526530    public this (bool val) 
    527         { 
    528                 // GdaValue* gda_value_new_boolean (gboolean val); 
    529                 this(cast(GdaValue*)gda_value_new_boolean(val) ); 
    530         } 
     531   { 
     532       // GdaValue* gda_value_new_boolean (gboolean val); 
     533       this(cast(GdaValue*)gda_value_new_boolean(val) ); 
     534   } 
    531535code: end 
    532536 
    533537 
    534538outFile: Value 
    535   

  • gtkD/wrap/APILookupGdkPixbuf.txt

    old new  
    182182     * the image isn't the expected type, for loading image formats 
    183183     * that can't be reliably identified by looking at the data, or if 
    184184     * the user manually forces a specific type. 
    185      * type: 
    186      *  name of the image format or mime to be loaded with the image 
    187      * error: 
    188      *  return location for an allocated GError, or NULL to ignore errors 
     185     * Params: 
     186     *  type = name of the image format or mime to be loaded with the image 
     187     *  error = return location for an allocated GError, or NULL to ignore errors 
    189188     * Returns: 
    190189     *  A newly-created pixbuf loader. 
    191190     */ 

  • gtkD/wrap/APILookupGdk.txt

    old new  
    277277code: start 
    278278    /** 
    279279     * Draws an outlined or filled polygon. 
    280      * drawable: 
    281      *  a GdkDrawable (a GdkWindow or a GdkPixmap). 
    282      * gc: 
    283      *  a GdkGC. 
    284      * filled: 
    285      *  TRUE if the polygon should be filled. The polygon is closed 
     280     * Params: 
     281     *  gc = a GdkGC. 
     282     *  filled = TRUE if the polygon should be filled. The polygon is closed 
    286283     *  automatically, connecting the last point to the first point if 
    287284     *  necessary. 
    288      * points: 
    289      *  an array of GdkPoint structures specifying the points making 
     285     *  points = an array of GdkPoint structures specifying the points making 
    290286     *  up the polygon. 
    291287     */ 
    292288    public void drawPolygon(GC gc, int filled, GdkPoint[] points) 
    …… 
    294290        // void gdk_draw_polygon (GdkDrawable *drawable,  GdkGC *gc,  gboolean filled,  GdkPoint *points,  gint npoints); 
    295291        gdk_draw_polygon(gdkDrawable, gc.getGCStruct(), filled, points.ptr, points.length); 
    296292    } 
    297      
     293 
     294    /** */ 
    298295    public void drawPixbuf(Pixbuf pixbuf, int destX, int destY) 
    299296    { 
    300297        drawPixbuf(null, pixbuf, destX, destY); 
    301298    } 
     299 
     300    /** */ 
    302301    public void drawPixbuf(GC gc, Pixbuf pixbuf, int destX, int destY) 
    303302    { 
    304303        if ( pixbuf is null ) return; 
    …… 
    310309                        GdkRgbDither.NORMAL,  
    311310                        0, 0); 
    312311    } 
    313  
    314  
    315       
    316      
    317312code: end 
    318313 
    319314outFile: Drawable 
    …… 
    454449     * This function calls gdk_drawable_get_image() internally and 
    455450     * converts the resulting image to a GdkPixbuf, so the 
    456451     * documentation for gdk_drawable_get_image() may also be relevant. 
    457      * dest: 
    458      *  Destination pixbuf, or NULL if a new pixbuf should be created. 
    459      * src: 
    460      *  Source drawable. 
    461      * cmap: 
    462      *  A colormap if src doesn't have one set. 
    463      * src_x: 
    464      *  Source X coordinate within drawable. 
    465      * src_y: 
    466      *  Source Y coordinate within drawable. 
    467      * dest_x: 
    468      *  Destination X coordinate in pixbuf, or 0 if dest is NULL. 
    469      * dest_y: 
    470      *  Destination Y coordinate in pixbuf, or 0 if dest is NULL. 
    471      * width: 
    472      *  Width in pixels of region to get. 
    473      * height: 
    474      *  Height in pixels of region to get. 
     452     * Params: 
     453     *  src = Source drawable. 
     454     *  cmap = A colormap if src doesn't have one set. 
     455     *  srcX = Source X coordinate within drawable. 
     456     *  srcY = Source Y coordinate within drawable. 
     457     *  destX = Destination X coordinate in pixbuf, or 0 if dest is NULL. 
     458     *  destY = Destination Y coordinate in pixbuf, or 0 if dest is NULL. 
     459     *  width = Width in pixels of region to get. 
     460     *  height = Height in pixels of region to get. 
    475461     * Returns: 
    476462     *  The same pixbuf as dest if it was non-NULL, or a newly-created 
    477      * pixbuf with a reference count of 1 if no destination pixbuf was specified, or NULL on error 
     463     *  pixbuf with a reference count of 1 if no destination pixbuf was specified, or NULL on error 
    478464     */ 
    479465    public Pixbuf getFromDrawable(Drawable src, Colormap cmap, int srcX, int srcY, int destX, int destY, int width, int height) 
    480466    { 
    …… 
    587573        this(new GdkColor); 
    588574    } 
    589575 
     576    /** */ 
    590577    this(ubyte red, ubyte green, ubyte blue) 
    591578    { 
    592579        this(); 
    …… 
    595582     
    596583    /** 
    597584     * Creates a new Color with RGB values 
    598      * @param red 
    599      * @param green 
    600      * @param blue 
     585     * Params:   
     586     *  red = 
     587     *  green = 
     588     *  blue = 
    601589     */ 
    602590    this(guint16 red, guint16 green, guint16 blue) 
    603591    { 
    …… 
    606594        set(red,green,blue); 
    607595    } 
    608596 
     597    /** */ 
    609598    this(uint rgb) 
    610599    { 
    611600        this(); 
    …… 
    613602        set( ((rgb&0xFFFF)),((rgb&0xFFFF00000000)>>32),(rgb&0xFFFF0000)>>16); 
    614603    } 
    615604 
     605    /** */ 
    616606    this(int rgb) 
    617607    { 
    618608        this(); 
    …… 
    620610        set8( cast(byte)((rgb&0xFF0000)>>16),cast(byte)((rgb&0x00FF00)>>8),cast(byte)(rgb&0xFF)); 
    621611    } 
    622612 
     613    /** */ 
    623614    static Color black() 
    624615    { 
    625616        if ( !_black ) 
    …… 
    628619        } 
    629620        return _black; 
    630621    } 
     622 
     623    /** */ 
    631624    static Color white() 
    632625    { 
    633626        if ( !_white ) 
    …… 
    639632     
    640633    /** 
    641634     * Sets the Color with RGB values 
    642      * @param red 
    643      * @param green 
    644      * @param blue 
     635     * Params: 
     636     *  red = 
     637     *  green = 
     638     *  blue = 
    645639     */ 
    646640    void set(guint16 red, guint16 green, guint16 blue) 
    647641    { 
    …… 
    655649        //printf("set pixel = %X\n", gdkColor.pixel); 
    656650    } 
    657651 
     652    /** */ 
    658653    void set8(ubyte red, ubyte green, ubyte blue) 
    659654    { 
    660655        //printf("Color.set %X %X %X\n",red,green,blue); 
    …… 
    666661        //printf("set8 pixel = %X\n", gdkColor.pixel); 
    667662    } 
    668663     
     664    /** */ 
    669665    uint getValue() 
    670666    { 
    671667        return (gdkColor.red <<32) | (gdkColor.green << 16) | (gdkColor.blue); 
    672668    } 
    673669     
     670    /** */ 
    674671    int getValue24() 
    675672    { 
    676673        return ((gdkColor.red&0xFF00)<<8 ) | ((gdkColor.green&0xFF00)) | ((gdkColor.blue&0xFF00) >>8); 
    677674    } 
    678675     
     676    /** */ 
    679677    uint getPixelValue() 
    680678    { 
    681679        return gdkColor.pixel; 
    …… 
    794792structWrap: GValue* Value 
    795793 
    796794code: start 
     795    /** */ 
    797796    public static bool isDoubleClick(GdkEventButton* eventButton, int buttonNumber=1) 
    798797    { 
    799798        return eventButton.button==buttonNumber  
    800799                && eventButton.type == EventType.DOUBLE_BUTTON_PRESS; 
    801800    } 
    802801 
     802    /** */ 
    803803    public static bool isTrippleClick(GdkEventButton* eventButton, int buttonNumber=1) 
    804804    { 
    805805        return eventButton.button==buttonNumber  
    806806                && eventButton.type == EventType.TRIPPLE_BUTTON_PRESS; 
    807807    } 
    808  
    809808code: end 
    810809 
    811810outFile: Event 
    …… 
    996995 
    997996code: end 
    998997outFile: GdkCairo 
    999  
    1000  
    1001  

  • gtkD/wrap/APILookupGLd.txt

    old new  
    9696    /** 
    9797     * Creates a mew OpenGL frame buffer configuration that match the specified display mode, 
    9898     * or the fallback mode. 
    99      * @param mode display mode bit mask. 
     99     * Params: 
     100     *  mode = display mode bit mask. 
     101     *  fallback = Try this mode if first fails. 
    100102     */ 
    101103    this(GLConfigMode mode, GLConfigMode fallback) 
    102104    { 

  • gtkD/wrap/APILookupGLib.txt

    old new  
    159159code: start 
    160160    /** 
    161161     * Increases the reference count on a GMainLoop object by one. 
    162      * loop: 
    163      *  a GMainLoop 
     162     * Params: 
     163     *  loop = a GMainLoop 
    164164     * Returns: 
    165165     *  loop 
    166166     */ 
    …… 
    461461    return copy.ptr; 
    462462} 
    463463 
     464    /** */ 
    464465    public static char** toStringzArray(char[][] args) 
    465466    { 
    466467        if ( args is null ) 
    …… 
    478479        return argv; 
    479480    } 
    480481 
     482    /** */ 
    481483    public static char[][] toStringArray(char** args) 
    482484    { 
    483485        if ( args is null ) 
    …… 
    498500        return argv; 
    499501    } 
    500502 
     503    /** */ 
    501504    public static char[] toString(bool b) 
    502505    { 
    503506        return b ? "true" : "false"; 
    504507    } 
    505508     
     509    /** */ 
    506510    public static char[] toString(char c) 
    507511    { 
    508512        char[] result = new char[2]; 
    …… 
    511515        return result[0 .. 1]; 
    512516    } 
    513517 
     518    /** */ 
    514519    public static char[] toString(ubyte ub)  { return toString(cast(uint) ub); } /// ditto 
     520    /** */ 
    515521    public static char[] toString(ushort us) { return toString(cast(uint) us); } /// ditto 
    516522     
     523    /** */ 
    517524    public static char[] toString(uint u) 
    518525    {   char[uint.sizeof * 3] buffer = void; 
    519526        int ndigits; 
    …… 
    539546        return result; 
    540547    } 
    541548 
     549    /** */ 
    542550    public static char[] toString(ulong u) 
    543551    {   char[ulong.sizeof * 3] buffer; 
    544552        int ndigits; 
    …… 
    560568        return result; 
    561569    } 
    562570 
     571    /** */ 
    563572    public static char[] toString(byte b)  { return toString(cast(int) b); } /// ditto 
     573    /** */ 
    564574    public static char[] toString(short s) { return toString(cast(int) s); } /// ditto 
    565575     
     576    /** */ 
    566577    public static char[] toString(int i) 
    567578    {   char[1 + int.sizeof * 3] buffer; 
    568579        char c; 
    …… 
    752763    /** 
    753764     * Adds a delegate to be notified on the end of the child process. 
    754765     * Params: 
    755      *      delegate(int = 
    756766     *      dlg = 
    757767     */ 
    758768    public void addChildWatch(ChildWatch dlg) 
    …… 
    11361146structWrap: GList* ListG 
    11371147 
    11381148code: start 
    1139    
     1149   /** */  
    11401150    void* data() 
    11411151    { 
    11421152        int* pt =cast(int*)getStruct(); 
    11431153        return cast(void *)(*pt); 
    11441154    } 
    1145       
    1146  
    1147  
    11481155code: end 
    11491156 
    11501157outFile: ListG