Changeset 337

Show
Ignore:
Timestamp:
12/28/07 18:09:45 (1 year ago)
Author:
Pse
Message:

Latest DDoc comment fixups courtesy of Mike Wey.
Not tested, not invasive :)

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/wrap/APILookupGLt.txt

    r322 r337  
    9797    /** 
    9898     * Gets the GL Frawable for (from???) the widget 
    99      * @param widget 
    100      * @return a new GLDrawable 
     99     * Params: 
     100     *  widget = 
     101     * Returns: a new GLDrawable 
    101102     */ 
    102103    static GLDrawable getGLDrawable(Widget widget) 

  • trunk/wrap/APILookupGObject.txt

    r322 r337  
    180180     
    181181    /** 
    182     * Sets a pointer on this object's has table 
    183     * @param key the data identifier 
    184     * @param data a pointer 
    185     */ 
     182     * Sets a pointer on this object's has table 
     183     * Params: 
     184     *  key = the data identifier 
     185     *  data = a pointer 
     186     */ 
    186187    public: void setDataFull(char[] key, gpointer data) 
    187188    { 
    …… 
    330331//  /** 
    331332//   * Sets a pointer on this object's has table 
    332 //   * @param key the data identifier 
    333 //   * @param data a pointer 
     333//   * Params: 
     334//   *  key = the data identifier 
     335//   *  data = a pointer 
    334336//   */ 
    335337//  private void setDestroyNotify(char[] key, gpointer data) 
    …… 
    356358//      } 
    357359//  } 
     360 
     361    /** */ 
    358362    public void setProperty(char[] propertyName, int value) 
    359363    { 
    …… 
    361365    } 
    362366     
     367    /** */ 
    363368    public void setProperty(char[] propertyName, char[] value) 
    364369    { 
    …… 
    366371    } 
    367372     
     373    /** */ 
    368374    public void setProperty(char[] propertyName, long value) 
    369375    { 
    …… 
    372378    } 
    373379 
     380    /** */ 
    374381    public void setProperty(char[] propertyName, ulong value) 
    375382    { 
    …… 
    430437 
    431438code: start 
    432  
     439    /** */ 
    433440    public this() 
    434441    { 
    435442        this(new GValue); 
    436443    } 
    437      
     444 
     445    /** */   
    438446    this(Pixbuf pixbuf) 
    439447    { 
    …… 
    444452        this(v); 
    445453    } 
    446      
     454 
     455    /** */ 
    447456    this(char[] value) 
    448457    { 
    …… 
    452461    } 
    453462 
     463    /** */ 
    454464    this(int value) 
    455465    { 
    …… 
    461471    /** 
    462472     * Initializes value with the default value of type. 
    463      * value: 
    464      * A zero-filled (uninitialized) GValue structure. 
    465      * g_type: 
    466      * Type the GValue should hold values of. 
     473     * Params: 
     474     *  value = A zero-filled (uninitialized) GValue structure. 
     475     *  g_type = Type the GValue should hold values of. 
    467476     * Returns: 
    468      * the GValue structure that has been passed in 
     477     * the GValue structure that has been passed in 
    469478     */ 
    470479    public Value init(GType gType) 
    …… 
    478487     * Clears the current value in value and resets it to the default value 
    479488     * (as if the value had just been initialized). 
    480      * value: 
    481      * An initialized GValue structure. 
     489     * Params: 
     490     * value = An initialized GValue structure. 
    482491     * Returns: 
    483      * the GValue structure that has been passed in 
     492     * the GValue structure that has been passed in 
    484493     */ 
    485494    public Value reset() 
    …… 
    544553 
    545554code: start 
    546  
    547  
     555    /** */ 
    548556    public static uint connectData(void* instanc, char[] detailedSignal, GCallback cHandler, Object data, GClosureNotify destroyData, GConnectFlags connectFlags) 
    549557    { 

  • trunk/wrap/APILookupGStreamer.txt

    r322 r337  
    181181    /** 
    182182     * Creates a new bin with the given name. 
    183      * name: 
    184      *  the name of the new bin 
     183     * Params: 
     184     *  name = the name of the new bin 
    185185     * Returns: 
    186186     *  a new GstBin 
    …… 
    192192    } 
    193193 
     194    /** */ 
    194195    public this(Element elem) 
    195196    { 
    …… 
    234235     * The watch can be removed using g_source_remove() or by returning FALSE 
    235236     * from func. 
    236      * bus: 
    237      *  a GstBus to create the watch for 
    238      * func: 
    239      *  A function to call when a message is received. 
    240      * user_data: 
    241      *  user data passed to func. 
     237     * MT safe. 
     238     * Params: 
     239     *  dlg = A function to call when a message is received. 
    242240     * Returns: 
    243241     *  The event source id. 
    244      * MT safe. 
    245242     */ 
    246243    public uint addWatch( bool delegate(Message) dlg ) 
    …… 
    269266     * You cannot replace an existing sync_handler. You can pass NULL to this 
    270267     * function, which will clear the existing handler. 
    271      * bus: 
    272      *  a GstBus to install the handler on 
    273      * func: 
    274      *  The handler function to install 
    275      * data: 
    276      *  User data that will be sent to the handler function. 
     268     * Params: 
     269     *  dlg = The handler function to install 
    277270     */ 
    278271    public void setSyncHandler( GstBusSyncReply delegate(Message) dlg ) 
    …… 
    530523     * The element will receive a guaranteed unique name, 
    531524     * consisting of the element factory name and a number. 
    532      * factoryname: 
    533      *  a named factory to instantiate 
     525     * Params: 
     526     *  factoryname = a named factory to instantiate 
    534527     * Returns: 
    535528     *  new GstElement or NULL if unable to create element 
    …… 
    560553     * elements that they should provide a buffer of the specified dimensions. 
    561554     * When the async flag is set, a thread boundary is prefered. 
    562      * format: 
    563      *  buffer format 
    564      * minsize: 
    565      *  minimum buffer size 
    566      * maxsize: 
    567      *  maximum buffer size 
    568      * async: 
    569      *  thread behavior 
     555     * Params: 
     556     *  format = buffer format 
     557     *  minsize = minimum buffer size 
     558     *  maxsize = maximum buffer size 
     559     *  async = thread behavior 
    570560     * Returns: 
    571561     *  a new GstEvent 
    …… 
    641631/** 
    642632     * Create a new navigation event from the given description. 
    643      * structure: 
    644      *  description of the event 
     633     * Params: 
     634     *  structure = description of the event 
    645635     * Returns: 
    646636     *  a new GstEvent 
    …… 
    708698     * padtemplate will be taken from the target pad. 
    709699     * Will ref the target. 
    710      * name: 
    711      *  the name of the new pad, or NULL to assign a default name. 
    712      * target: 
    713      *  the pad to ghost. 
     700     * Params: 
     701     *  name = the name of the new pad, or NULL to assign a default name. 
     702     *  target = the pad to ghost. 
    714703     * Returns: 
    715704     *  a new GstPad, or NULL in case of an error. 
    …… 
    931920     * output argument is a copy; the caller must free it when done. 
    932921     * MT safe. 
    933      * message: 
    934      *  A valid GstMessage of type GST_MESSAGE_TAG. 
    935      * tag_list: 
    936      *  Return location for the tag-list. 
     922     * Params: 
     923     *  tagList = Return location for the tag-list. 
    937924     */ 
    938925    /*public void parseTag(GstTagList** tagList) 
    …… 
    952939    /** 
    953940     * Get the unique quark for the given message type. 
    954      * type: 
    955      *  the message type 
     941     * Params: 
     942     *  type = the message type 
    956943     * Returns: 
    957944     *  the quark associated with the message type 
    …… 
    968955     * "the firewire cable was unplugged". The format of the message should be 
    969956     * documented in the element's documentation. The structure field can be NULL. 
    970      * src: 
    971      * The object originating the message. 
    972      * structure: 
    973      *  The structure for the message. The message will take ownership of 
    974      * the structure. 
     957     * MT safe. 
     958     * Params: 
     959     * src = The object originating the message. 
     960     *  structure = The structure for the message. The message will take ownership of 
     961     * the structure. 
    975962     * Returns: 
    976963     *  The new element message. 
    977      * MT safe. 
    978964     */ 
    979965    public static Message newElement(ObjectGst src, Structure structure) 
    …… 
    986972     * Create a new clock message. This message is posted whenever the 
    987973     * pipeline selectes a new clock for the pipeline. 
    988      * src: 
    989      * The object originating the message. 
    990      * clock: 
    991      *  the new selected clock 
     974     * MT safe. 
     975     * Params: 
     976     * src = The object originating the message. 
     977     *  clock = the new selected clock 
    992978     * Returns: 
    993979     *  The new new clock message. 
    994      * MT safe. 
    995980     */ 
    996981    public static Message newNewClock(ObjectGst src, Clock clock) 
    …… 
    1005990     * is received by the application after all elements that posted a segment_start 
    1006991     * have posted the segment_done. 
    1007      * src: 
    1008      *  The object originating the message. 
    1009      * format: 
    1010      *  The format of the position being done 
    1011      * position: 
    1012      *  The position of the segment being done 
     992     * MT safe. 
     993     * Params: 
     994     *  src = The object originating the message. 
     995     *  format = The format of the position being done 
     996     *  position = The position of the segment being done 
    1013997     * Returns: 
    1014998     *  The new segment done message. 
    1015      * MT safe. 
    1016999     */ 
    10171000    public static Message newSegmentDone(ObjectGst src, GstFormat format, long position) 
    …… 
    10261009     * is not received by the application but is used for maintenance reasons in 
    10271010     * container elements. 
    1028      * src: 
    1029      *  The object originating the message. 
    1030      * format: 
    1031      *  The format of the position being played 
    1032      * position: 
    1033      *  The position of the segment being played 
     1011     * MT safe. 
     1012     * Params: 
     1013     *  src = The object originating the message. 
     1014     *  format = The format of the position being played 
     1015     *  position = The position of the segment being played 
    10341016     * Returns: 
    10351017     *  The new segment start message. 
    1036      * MT safe. 
    10371018     */ 
    10381019    public static Message newSegmentStart(ObjectGst src, GstFormat format, long position) 
    …… 
    10451026     * Create a new warning message. The message will make copies of error and 
    10461027     * debug. 
    1047      * src: 
    1048      *  The object originating the message. 
    1049      * error: 
    1050      *  The GError for this message. 
    1051      * debug: 
    1052      *  A debugging string for something or other. 
     1028     * MT safe. 
     1029     * Params: 
     1030     *  src = The object originating the message. 
     1031     *  error = The GError for this message. 
     1032     *  debug = A debugging string for something or other. 
    10531033     * Returns: 
    10541034     *  The new warning message. 
    1055      * MT safe. 
    10561035     */ 
    10571036    public static Message newWarning(ObjectGst src, ErrorG error, char[] dbug) 
    …… 
    10651044     * changed its state asynchronously and is used internally to update the 
    10661045     * states of container objects. 
    1067      * src: 
    1068      *  the object originating the message 
     1046     * MT safe. 
     1047     * Params: 
     1048     *  src = the object originating the message 
    10691049     * Returns: 
    10701050     *  The new state dirty message. 
    1071      * MT safe. 
    10721051     */ 
    10731052    public static Message newStateDirty(ObjectGst src) 
    …… 
    10811060     * the sink elements of a GstBin. The bin will only forward the EOS 
    10821061     * message to the application if all sinks have posted an EOS message. 
    1083      * src: 
    1084      *  The object originating the message. 
     1062     * MT safe. 
     1063     * Params: 
     1064     *  src = The object originating the message. 
    10851065     * Returns: 
    10861066     *  The new eos message. 
    1087      * MT safe. 
    10881067     */ 
    10891068    public static Message newEOS(ObjectGst src) 
    …… 
    10981077     * occured. The pipeline will probably (partially) stop. The application 
    10991078     * receiving this message should stop the pipeline. 
    1100      * src: 
    1101      *  The object originating the message. 
    1102      * error: 
    1103      *  The GError for this message. 
    1104      * debug: 
    1105      *  A debugging string for something or other. 
     1079     * MT safe. 
     1080     * Params: 
     1081     *  src = The object originating the message. 
     1082     *  error = The GError for this message. 
     1083     *  debug = A debugging string for something or other. 
    11061084     * Returns: 
    11071085     *  The new error message. 
    1108      * MT safe. 
    11091086     */ 
    11101087    public static Message newError(ObjectGst src, ErrorG error, char[] dbug) 
    …… 
    11171094     * Create a new info message. The message will make copies of error and 
    11181095     * debug. 
    1119      * src: 
    1120      * The object originating the message. 
    1121      * error: 
    1122      *  The GError for this message. 
    1123      * debug: 
    1124      *  A debugging string for something or other. 
     1096     * MT safe. 
     1097     * Since 0.10.12 
     1098     * Params: 
     1099     *  src = The object originating the message. 
     1100     * error = The GError for this message. 
     1101     *  debug = A debugging string for something or other. 
    11251102     * Returns: 
    11261103     *  The new info message. 
    1127      * Since 0.10.12 
    1128      * MT safe. 
    11291104     */ 
    11301105    public static Message newInfo(ObjectGst src, ErrorG error, char[] dbug) 
    …… 
    11951170     * constructs like : 
    11961171     *  result = gst_object_ref (object->parent); 
    1197      * object: 
    1198      *  a GstObject to reference 
    11991172     * Returns: 
    12001173     *  A pointer to object 
    …… 
    12581231prefix: gst_ 
    12591232code: start 
     1233/** */ 
    12601234public this (char[] name) 
    12611235{ 
    …… 
    13061280     * allowed. A copy is made of the name so you should free the supplied name 
    13071281     * after calling this function. 
    1308      * feature: 
    1309      *  a feature 
    1310      * name: 
    1311      *  the name to set 
     1282     * Params: 
     1283     *  name = the name to set 
    13121284     */ 
    13131285    public void setFeatureName(char[] name) 
    …… 
    13301302     * when done with it. A position query is used to query the current position 
    13311303     * of playback in the streams, in some format. 
    1332      * format: 
    1333      *  the default GstFormat for the new query 
     1304     * Params: 
     1305     *  format = the default GstFormat for the new query 
    13341306     * Returns: 
    13351307     *  A GstQuery 
    …… 
    13471319     * Use gst_query_unref() when done with it. A duration query will give the 
    13481320     * total length of the stream. 
    1349      * format: 
    1350      *  the GstFormat for this duration query 
     1321     * Params: 
     1322     *  format = the GstFormat for this duration query 
    13511323     * Returns: 
    13521324     *  A GstQuery 
    …… 
    13631335     * Constructs a new query object for querying seeking properties of 
    13641336     * the stream. 
    1365      * format: 
    1366      *  the default GstFormat for the new query 
     1337     * Params: 
     1338     *  format = the default GstFormat for the new query 
    13671339     * Returns: 
    13681340     *  A GstQuery 
    …… 
    13791351     * Constructs a new query object for querying formats of 
    13801352     * the stream. 
     1353     * Since 0.10.4 
    13811354     * Returns: 
    13821355     *  A GstQuery 
    1383      * Since 0.10.4 
    13841356     */ 
    13851357    public static Query newFormats() 
    …… 
    13951367     * when done with it. A segment query is used to discover information about the 
    13961368     * currently configured segment for playback. 
    1397      * format: 
    1398      *  the GstFormat for the new query 
     1369     * Params: 
     1370     *  format = the GstFormat for the new query 
    13991371     * Returns: 
    14001372     *  a GstQuery 

  • trunk/wrap/APILookupPango.txt

    r322 r337  
    265265    /** 
    266266     * Creates a nwe font description and set the family nd the size 
    267      * param: family Family 
    268      * param: size Size 
     267     * Params: 
     268     *  family = Family 
     269     *  size = Size 
    269270     */ 
    270271    public this(char[] family, int size) 
    …… 
    670671    /** 
    671672     * Sets the text of the layout. 
    672      * layout: 
    673      *  a PangoLayout 
    674      * text: 
    675      *  a UTF-8 string 
     673     * Params: 
     674     *  text = a UTF-8 string 
    676675     */ 
    677676    public void setText(char[] text) 

  • trunk/wrap/APILookupSourceView.txt

    r322 r337  
    7878     * The reference count on the buffer is not incremented; the caller 
    7979     * of this function won't own a new reference. 
    80      * text_view: 
    81      *  a GtkSourceView 
    8280     * Returns: 
    8381     *  a GtkSourceBuffer