Hi,
if you're following git, you may have noticed that Jon and me have quite a
few commits that only touch documentation, recently. I thought I should
explain here what we this is about: We are trying to improve the developer
documentation for application developers.
The reference document
On Sat, Feb 1, 2014 at 10:08 AM, Matthias Clasen
wrote:
- Make the doc comments more readable by moving from clunky docbook
markup
to markdown. This will help both for reading and updating the
documentation in
the sources, and for limiting the scope of whar our
documentation-generating
On Sat, Feb 1, 2014 at 10:19 AM, Colin Walters wrote:
>
> Interesting. I'm in favor of Markdown. But does gtk-doc understand it at
> all?
>
> I agree this would be a *really* useful endeavor, I just didn't have the
> motivation to dive
> in and translate Docbook to something else myself, but if
hi;
On 1 February 2014 15:19, Colin Walters wrote:
> On Sat, Feb 1, 2014 at 10:08 AM, Matthias Clasen
> wrote:
>
>
> - Make the doc comments more readable by moving from clunky docbook markup
> to markdown. This will help both for reading and updating the
> documentati
On Feb 1, 2014 4:09 PM, "Matthias Clasen" wrote:
>
> Hi,
>
> if you're following git, you may have noticed that Jon and me have quite
a few commits that only touch documentation, recently. I thought I should
explain here what we this is about: We are trying to improve
There is gtk-engines development documentation somwhere? I'm unable to
find it on gtk.org.
Regards,
Alberto Ruiz
___
gtk-devel-list mailing list
gtk-devel-list@gnome.org
http://mail.gnome.org/mailman/listinfo/gtk-devel-list
Hello,
Here is a little patch against gtk+ 2.12.1 documentation :
gtknotebook.sgml :
corrected some mistakes (noteobook -> notebook) and
wrong references (gtk_notebook_enable_popup ->
gtk_notebook_popup_enable)
gtkradiobutton.sgml :
changed @group to @radio_group_member where needed
Plea
A couple of weeks back I wrote a bunch of GObject documentation fixes
and created a Bugzilla bug for them
(http://bugzilla.gnome.org/show_bug.cgi?id=490637) and attached my
changes as a patch. The fixes address a couple of errors related to
object construction and type macros, and also
GLib Reference Documentation should mention that:
1 - 'error' must be initialized to NULL before call
'g_spawn_command_line_sync'
2 - 'standard_output' and 'standard_error'
must be freed with 'g_free' after use.
3 - 'error' must be
Hi all
Since you guys are discussing the redesign of the gtk+ website, I'd
like to propose an idea that I have. I've seen quite a lot of comments
saying gtk+ documentation isn't as good as qt's. What do you think of
having a wiki that docum
Hi,
I have written some documentation of the GtkTextBuffer signals.
If this is useful I will try to find time to continue with more signals
- they seems to be neglected in most of the documentation.
I include a patch against 2.6.7 and would like to hear your
comments/criticism.
Is this
This patch documents GtkWidget's destroy-event, expose-event and
configure-event's signals, and fixes the name for the grab-focus-event
documentation.
Index: gtk/gtkwidget.c
===
--- gtk/gtkwidget.c (revision 5)
+++ gtk/g
On 1/17/06, Alberto Ruiz <[EMAIL PROTECTED]> wrote:
> There is gtk-engines development documentation somwhere? I'm unable to
> find it on gtk.org.
The only thing I know of is Owens old writeup:
http://www.gtk.org/~otaylor/gtk/2.0/t
On 1/17/06, Matthias Clasen <[EMAIL PROTECTED]> wrote:
> On 1/17/06, Alberto Ruiz <[EMAIL PROTECTED]> wrote:
> > There is gtk-engines development documentation somwhere? I'm unable to
> > find it on gtk.org.
>
> The only thing I know of is Owens old writeup:
&
, because I interested in learning
how to use cairo to perform an engine, so I walked through the code but
I was unable to figure out the structure, so I was looking for more
"formal" documentation.
> A reference implementation with all the autotools and scanner magic
> done for you and
> how to use cairo to perform an engine, so I walked through the code but
> I was unable to figure out the structure, so I was looking for more
> "formal" documentation.
>
> > A reference implementation with all the autotools and scanner magic
> > done for you and
perform an engine, so I walked through the code but
I was unable to figure out the structure, so I was looking for more
"formal" documentation.
A reference implementation with all the autotools and scanner magic
done for you and stub draw functions which call the parent (ie.
default t
2007/11/7, Olivier Delhomme <[EMAIL PROTECTED]>:
Olivier,
> Please let me know if anything is not as it should be in this
> patch.
You should open a bug into bugzilla and attach your patch in there,
it's easier to review and you will be sure that the maintainers will
read your message.
cheers
-
2007/11/11, Gian Mario Tagliaretti :
>
> 2007/11/7, Olivier Delhomme :
>
> Olivier,
>
> > Please let me know if anything is not as it should be in this
> > patch.
>
> You should open a bug into bugzilla and attach your patch in there,
> it's easier to review and you will be sure that the maintainer
On Wed, 2009-01-07 at 18:08 +0100, Valerio Messina wrote:
> GLib Reference Documentation should mention that:
> 1 - 'error' must be initialized to NULL before call
> 'g_spawn_command_line_sync'
> 3 - 'error' must be freed with: if (errorPtr) g_error_free (
That's hard-ish to do today. GTK+'s documentation is generated in
large part by scanning comments in C code, which a program then turns
into HTML. Any proposal would require a way to keep the Wiki and the C
comments in-sync.
On Thu, Feb 19, 2009 at 10:28 AM, Eugene Gorodinsky
wrote
Have there been cases where documentation for some function was
changed after that function appeared in the stable version?
2009/2/19 Dominic Lachowicz :
> That's hard-ish to do today. GTK+'s documentation is generated in
> large part by scanning comments in C code, which a pr
Yes. The most common example I can think of is when a function is deprecated.
On Thu, Feb 19, 2009 at 10:52 AM, Eugene Gorodinsky
wrote:
> Have there been cases where documentation for some function was
> changed after that function appeared in the stable version?
>
> 2009/2/19 Domin
Am Donnerstag, den 19.02.2009, 10:33 -0500 schrieb Dominic Lachowicz:
> That's hard-ish to do today. GTK+'s documentation is generated in
> large part by scanning comments in C code, which a program then turns
> into HTML. Any proposal would require a way to keep the Wiki and
A way to overcome that, would be to put a warning on the wiki page
whenever the documentation for a function is updated, so that the
users could see the updated comment in the code and update the
documentation accordingly.
P.S. Sorry for sending the message twice
2009/2/19 Dominic Lachowicz
On Thu, 2009-02-19 at 16:56 +0100, Mathias Hasselmann wrote:
> Am Donnerstag, den 19.02.2009, 10:33 -0500 schrieb Dominic Lachowicz:
> > That's hard-ish to do today. GTK+'s documentation is generated in
> > large part by scanning comments in C code, which a program then
Eugene Gorodinsky writes:
> Hi all
>
> Since you guys are discussing the redesign of the gtk+ website, I'd
> like to propose an idea that I have. I've seen quite a lot of comments
> saying gtk+ documentation isn't as good as qt's. What do you think of
> h
hi,
Maciej Piechotka schrieb:
> Eugene Gorodinsky writes:
>
>> Hi all
>>
>> Since you guys are discussing the redesign of the gtk+ website, I'd
>> like to propose an idea that I have. I've seen quite a lot of comments
>> saying gtk+ documentati
As I understood the way this thing would work is: after the gtk-doc
tool genereates documentation a cgi is executed that would add the new
version of the documentation to the wiki database, and whenever the
documentation in the wiki gets modified, another cgi is executed that
would change the
Stefan Kost writes:
> hi,
>
> Maciej Piechotka schrieb:
>> Eugene Gorodinsky writes:
>>
>>> Hi all
>>>
>>> Since you guys are discussing the redesign of the gtk+ website, I'd
>>> like to propose an idea that I have. I've seen
Le vendredi 20 février 2009, à 14:32 +0200, Stefan Kost a écrit :
> Would thank be enough for a GSoC project? I would mentor it, but I would
> rather
> juck hack with someone diretly on it? Who joins?
I'd rather have the SoC project be the web interface that makes the doc
editable. Maybe based on
Mathias Hasselmann wrote:
Am Donnerstag, den 19.02.2009, 10:33 -0500 schrieb Dominic Lachowicz:
That's hard-ish to do today. GTK+'s documentation is generated in
large part by scanning comments in C code, which a program then turns
into HTML. Any proposal would require a way to kee
d
>>>> like to propose an idea that I have. I've seen quite a lot of comments
>>>> saying gtk+ documentation isn't as good as qt's. What do you think of
>>>> having a wiki that documents all of gtk+ api?
>>> I'm not sure but I guess that it wo
Stefan Kost writes:
> Eugene, Maciej,
>
> I've have some concept for the gtk-doc side of things. For the server side
> I've
> ideas too, if you want to join, there is #gtkdoc on gimpnet irc. Lets discuss
> there. Need to talk to the web-site hackers to come up with the easiest/best
> way
> to i
at I have. I've seen quite a lot of comments
> >> saying gtk+ documentation isn't as good as qt's. What do you think of
> >> having a wiki that documents all of gtk+ api?
> >
> > I'm not sure but I guess that it would be possible to integrate
iscussing the redesign of the gtk+ website, I'd
>>>> like to propose an idea that I have. I've seen quite a lot of comments
>>>> saying gtk+ documentation isn't as good as qt's. What do you think of
>>>> having a wiki that documents all of gtk
Stefan Kost wrote:
> subtasks that I could need help with:
> 1) start a basic cgi for library.gnome.org (if I do it its gonna be
> perl, but I don't care so much)
> * have a hasmap there docmodule->sourcedir
> * implements a fast way to get from symbol to docblob
> * when calling edit.cgi?do
n of the gtk+ website, I'd
>>>>> like to propose an idea that I have. I've seen quite a lot of comments
>>>>> saying gtk+ documentation isn't as good as qt's. What do you think of
>>>>> having a wiki that documents all of gtk+ api
t; >>>
> >>>> Hi all
> >>>>
> >>>> Since you guys are discussing the redesign of the gtk+ website, I'd
> >>>> like to propose an idea that I have. I've seen quite a lot of comments
> >>>> saying gtk+ doc
https://developer.gnome.org/ is failing to connect for me, reporting the
following error:
> Secure Connection Failed
>
> An error occurred during a connection to developer.gnome.org.
>
> SSL received a record that exceeded the maximum permissible length.
>
> (Error code: ssl_error_rx_record_too
o something it was already capable of doing, but
wasn't obvious from its API documentation.
<https://bugzilla.gnome.org/show_bug.cgi?id=729892>
I've submitted the above bug report and included a patch I wrote that
appears to solve this. Please consider reviewing and
On Mon, 2005-09-19 at 23:39 +0200, Søren Wedel Nielsen wrote:
> Hi,
>
> I have written some documentation of the GtkTextBuffer signals.
>
> If this is useful I will try to find time to continue with more signals
> - they seems to be neglected in most of the documentation
tir, 20 09 2005 kl. 09:12 -0400, skrev Matthias Clasen:
> On Mon, 2005-09-19 at 23:39 +0200, Søren Wedel Nielsen wrote:
> > Hi,
> >
> > I have written some documentation of the GtkTextBuffer signals.
> >
> > If this is useful I will try to find time to cont
Now 2.14 has been released, I wonder whether anyone on
the GTK team could review the documentation I wrote
for the Open and Save dialogs.
It's in the GNOME Desktop User Guide, under Desktop
Overview/Applications: 2.5.3. Choosing a File to
Open and 2.5.4. Saving a File.
It was requested the
concerning the atk documentation and will appreciate if
the atk maintainers could give us comments on this matter.
The questions below apply to both a non-changing version of the GTK+ 2.6 API
documentation and newer GTK+ 2.x API Reference presented at gtk.org.
1. The API reference for some ATK
Hi, I am interested in learning more about the internals of GObject
Introspection and the steps to make a binding for a GObject based C
libraries to some language. However, the current documentation is not very
complete on how to go about this.
Is there a good document, or a good example, on
Am Donnerstag, den 19.02.2009, 17:52 +0200 schrieb Eugene Gorodinsky:
> Have there been cases where documentation for some function was
> changed after that function appeared in the stable version?
Yes, this happens frequently: Spelling errors, explanations of
limitations, code examples,
Hi,
I'm currently scanning the nice "Index of new symbols in 2.8"
documents, and while they are immensely useful, I have noticed that
they don't list new properties and new signals. For example,
GdkEventGrabBroken is a new symbol of gdk, and grab-broken-event is a
new signal of GtkWidget but the l
On 3/17/06, Joachim Noreiko <[EMAIL PROTECTED]> wrote:
> Now 2.14 has been released, I wonder whether anyone on
> the GTK team could review the documentation I wrote
> for the Open and Save dialogs.
>
> It's in the GNOME Desktop User Guide, under Desktop
> Overview/Ap
--- Matthias Clasen <[EMAIL PROTECTED]> wrote:
> On 3/17/06, Joachim Noreiko <[EMAIL PROTECTED]>
> wrote:
> > Now 2.14 has been released, I wonder whether
> anyone on
> > the GTK team could review the documentation I
> wrote
> > for the Open and Save
2009/1/8 Andy Tai :
> Hi, I am interested in learning more about the internals of GObject
> Introspection and the steps to make a binding for a GObject based C
> libraries to some language. However, the current documentation is not very
> complete on how to go about this.
I&#x
On Fri, Jan 9, 2009 at 3:28 PM, Colin Walters wrote:
> 2009/1/8 Andy Tai :
>> Hi, I am interested in learning more about the internals of GObject
>> Introspection and the steps to make a binding for a GObject based C
>> libraries to some language. However, the current docum
ries to some language. However, the current documentation is not very
>>> complete on how to go about this.
>>
>> I'm working on a tutorial, hopefully will appear this weekend.
>
> Here's the first version:
>
> http://live.gnome.org/GObjectIntrospection/FromH
Hi,
I would like to print the GTK+ documentation :
http://www.gtk.org/documentation.html
I successfully built GTK+ from sources with the following :
./configure --without-libtiff --without-libjasper --enable-gtk-doc && make
The HTML documentation were generated successfully.
Then I
While I was reading the documentation of GtkTextView [1] I came up to
an "error". I moved to the section about
gtk_text_view_add_child_in_window [2] and read the help:
". a possible hack would be to update all child positions when the
scroll adjustments change or the text buff
Hey there,
While browsing the GTK+ CSS documentation lately in my web browser, I
noticed a weird phenomenon. If you do a research on 'font-' (for
example), most of the 'font-' strings are left out of the search results.
You can try it easily. Go on this page, and do a resear
On Tue, 2005-09-20 at 20:26 +0200, Guillaume Cottenceau wrote:
> Hi,
>
> I'm currently scanning the nice "Index of new symbols in 2.8"
> documents, and while they are immensely useful, I have noticed that
> they don't list new properties and new signals. For example,
> GdkEventGrabBroken is a new
Manu schrieb:
> Hi,
>
> I would like to print the GTK+ documentation :
> http://www.gtk.org/documentation.html
>
> I successfully built GTK+ from sources with the following :
> ./configure --without-libtiff --without-libjasper --enable-gtk-doc && make
>
> Th
murrayc.com/blog/permalink/2009/01/20/flumotion-documentation/
--
murr...@murrayc.com
www.murrayc.com
www.openismus.com
___
gtk-devel-list mailing list
gtk-devel-list@gnome.org
http://mail.gnome.org/mailman/listinfo/gtk-devel-list
the bugs I found last time are now fixed.
> http://www.murrayc.com/blog/permalink/2009/01/20/flumotion-documentation/
>
I tried using various versions of fop, but get java backtraces for all of them.
I filed bugs for those, but nothing happens there :/
Stefan
__
n use fop. And that's not as difficult as it
>> once was. I think most of the bugs I found last time are now fixed.
>> http://www.murrayc.com/blog/permalink/2009/01/20/flumotion-documentation/
>>
> I tried using various versions of fop, but get java backtraces for all of
> th
se
>>>> days.
>>>
>>> It's not that bad if you can use fop. And that's not as difficult as it
>>> once was. I think most of the bugs I found last time are now fixed.
>>> http://www.murrayc.com/blog/permalink/2009/01/20/flumotion-documentation/
&
tunately the docbook to pdf chain is in terrible state these
>>>>> days.
>>>> It's not that bad if you can use fop. And that's not as difficult as it
>>>> once was. I think most of the bugs I found last time are now fixed.
>>>> http://www.murra
once was. I think most of the bugs I found last time are now fixed.
>>>>> http://www.murrayc.com/blog/permalink/2009/01/20/flumotion-documentation/
>>>>>
>>>> I tried using various versions of fop, but get java backtraces for all of
>>>> them.
&
On Sun, 2009-07-05 at 14:34 +0200, Nicolò Chieffo wrote:
> While I was reading the documentation of GtkTextView [1] I came up to
> an "error". I moved to the section about
> gtk_text_view_add_child_in_window [2] and read the help:
> ". a possible hack would be to
On Sun, Jul 5, 2009 at 11:56 PM, Owen Taylor wrote:
> Why don't you think this problem is fixed?
>
> - Owen
In my opinion it's not fixed because of 2 things:
1) the doc explains the absence of an API to detect scrolling events,
and then cites bug number 64518 (which is marked fixed), but there's
s
; Unfortunately the docbook to pdf chain is in terrible state these
>>>>>>> days.
>>>>>>>
>>>>>> It's not that bad if you can use fop. And that's not as difficult as it
>>>>>> once was. I think m
ook to pdf chain is in terrible state these
>>>>>>>> days.
>>>>>>>>
>>>>>>>>
>>>>>>> It's not that bad if you can use fop. And that's not as difficult as it
>>
;> Murray Cumming schrieb:
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>>> On Mon, 2009-06-29 at 22:23 +0300, Stefan Kost wrote:
>>>>>>>>
>>>>>>>>
Hi,
guys, your thread is impressing. Just look at the last post and enjoy
how the quotation level raises to its maximum in the middle of this mail
where the author replies to himself for the third time in a row, always
quoting the full previous post. Brilliant. Thanks for this wonderful
work. It w
now how it translates in our GTK XML documentation. We can
use the element along with the 'role' attribute. Example with a
table entry from the file css-properties.xml.
-gtk-outline-bottom-left-radius
In the generated HTML, it translates to:
-gtk-outline-bottom-left-radius
Onc
be-broken
> CSS:span.nobr { white-space: nowrap; }
>
> And this is now how it translates in our GTK XML documentation. We can
> use the element along with the 'role' attribute. Example with a
> table entry from the file css-properties.xml.
>
> role="nobr&qu
On Thu, 24 Mar 2005 07:58:19 -0500, Owen Taylor <[EMAIL PROTECTED]> wrote:
> On Thu, 2005-03-24 at 13:09 +0100, Miroslav Rajcic wrote:
> > > On Thu, 24 Mar 2005 11:40:35 +0100, Miroslav Rajcic <[EMAIL PROTECTED]>
> > >
> > > You can listen for changes to the "position" property on GtkPaned:
> > >
>
Hi,
I am new the GTK-Doc tools.
I am trying to add gtk-doc support to generate API documentation
for the Upstart project(an open source Init replacement).
The code seems to already be heavily commented for the GTK-Doc tool but
the GTK-Doc tooling in the makefile did not exist and I am
Hi all.
I noticed that there is a conflict in what GtkBin docs say:
http://developer.gnome.org/doc/API/2.0/gtk/GtkBin.html#GtkBin-struct
"
The GtkBin-struct struct contains the following fields. (These fields
should be considered read-only. They should never be set by an
application.)
GtkWidget
Hi,
Saravanan Shanmugham (sarvi) schrieb:
Hi,
I am new the GTK-Doc tools.
I am trying to add gtk-doc support to generate API documentation
for the Upstart project(an open source Init replacement).
The code seems to already be heavily commented for the GTK-Doc tool but
the GTK-Doc
> about the gap in documentation?
>
> Note: gtk-devel in the CC because the mailing list page indicates that
> documentation improvements should be discussed on it. Apologies if this
> is in error.
https://wiki.gnome.org/HowDoI/CustomWidgets
is my attempt at clo
Le mardi 03 janvier 2006 à 12:00 +0200, Kalle Vahlman a écrit :
> Hi all.
>
> I noticed that there is a conflict in what GtkBin docs say:
>
> http://developer.gnome.org/doc/API/2.0/gtk/GtkBin.html#GtkBin-struct
> "
> The GtkBin-struct struct contains the following fields. (These fields
> should b
these disagree. The GtkBin docs say you can
access the child via the struct, but to consider it read-only. The
GtkComboBoxEntry docs say you can access its GtkEntry by getting the
child of the GtkBin via the struct, which doesn't IMO contradict the
GtkBin documentation.
> Considerati
child of the GtkBin via the struct, which doesn't IMO contradict the
> GtkBin documentation.
*slaps forehead*
I totally carelessly misread the comment as the usual "considered
private, do not touch".
Sorry for the interruption, move along, nothing to see here :)
--
Kalle V
80 matches
Mail list logo
