Re: 1.17 cross refs

Hi Phil, On 09/14/11 23:36, Philip Kovacs wrote: > I observe that the process to build fully linked documentation from a > pristine > source tree (dist|maintainer clean) is two-pass when there are subtrees that > have cross references to each other. This is understandable, as there must > be

Re: GTKDOC_DEPS in recent gtk-doc.m4

On 12/01/2011 08:30 PM, Nicola Fontana wrote: > On Sun, 20 Nov 2011 22:13:34 +0100 > Simon Josefsson wrote: > >> Hi! I'm using gtk-doc in for example GNU Libtasn1 and recently upgraded >> to the latest gtk-doc.m4 from your git repo, which contains this new >> piece of code: >> >> dnl don't ch

Re: GTKDOC_DEPS in recent gtk-doc.m4

On 12/04/2011 12:49 PM, Simon Josefsson wrote: > Stefan Sauer writes: > >> On 12/01/2011 08:30 PM, Nicola Fontana wrote: >>> On Sun, 20 Nov 2011 22:13:34 +0100 >>> Simon Josefsson wrote: >>> >>>> Hi! I'm using gtk-doc in for example G

Re: Translation of GTK+ 3 Reference Manual

On 01/28/2012 11:02 PM, Rogelio Guzmán wrote: > Hello. > > I have just discovered the GTK+ Reference Manual at > http://developer.gnome.org/gtk3/3.0/; > I have always wanted some how to contribute to gtk or Gnome. Hi, please write to the GnomeDoc list. This list is about the gtk-doc tool that i

removal of legacy "returns" blcoks with next gtk-doc release

hi, for legacy reasons gtk-doc accepted documenting the return value by starting a line with "Returns" (not Returns:") [1]. This of course can be ambiguous and thus is not recommended. Normally one can disambiguate, by having a proper Returns: block. Still this can cause trouble for void functions

Re: Resolving cross-references among components

On 11/18/2012 12:12 AM, David Nečas wrote: > Hello, what is the recommended method/best practice for getting right > bidirectional cross-references in documentation? > > Imagine a project that builds two libraries, libA and libB, with > separate documentation. If documentation for libA is built wh

Re: What is the license of generated files?

On 12/10/2012 05:41 PM, Jeff Johnston wrote: > I wish to use gtk-doc to create a test case for the Eclipse devhelp > plug-in. I have a simple C test with one function which I generate > devhelp for. The generation results in a set of files: a css file, > the devhelp file, some .png files (home.pn

Re: Patch submit

On 12/25/2012 02:29 PM, Kevin Connor Arpe wrote: > Hi, > > I have a tiny patch to submit to hyperlink default object property values. > Stuff like PANGO_ALIGN_LEFT would become a hyperlink, but not 123 or > "abc". > I am not a regular developer for this project, so I do not have a > GNOME Git accou

gtk:doc: dropping support for legacy return 'markup'

hi, while the proper annotation for return values in gtk-doc is: * ... * Returns: foo bar * ... the tool also looks for lines starting with "returns " at the start of a documentation body block (for legacy reasons). A following proper "Returns:" tag would override the legacy returns docs. The to

Re: What is the license of generated files?

+legal-list, any suggestions? Stefan On 02/04/2013 11:03 PM, Jeff Johnston wrote: > On 12/14/2012 01:11 PM, David Nečas wrote: >> On Fri, Dec 14, 2012 at 12:54:13PM -0500, Jeff Johnston wrote: >>> I personally like the exception method ala Autotools but would be >>> fine with the GFDL 1.3 license

Re: What is the license of generated files?

On 07/01/2013 01:41 PM, Tobias Mueller wrote: > Hi Stefan, > > On Fri, May 31, 2013 at 02:25:06PM +0200, Stefan Sauer wrote: >> +legal-list, any suggestions? >> > To clear up the situation: What PNG file is this about? > > Cheers, > Tobi https://git.gnom

Re: What is the license of generated files?

On 07/19/2013 01:20 PM, Tobias Mueller wrote: > Aloha :) > > On Fri, Jul 19, 2013 at 01:00:24PM +0300, Luc Pionchon wrote: >> Especially here we are talking about three very basic icons >> (navigation icons). It is trivial to do new ones if (re)licensing is a >> problem. >> > cool. That's probably

spring cleaning in gtk-doc for next-next verison (1.21)

hi, while a gtk-doc 1.20 is brewing with some awesome stuff coming, I like to remove some legacy features in the cycle afterwards. 1) I'd like to remove 'gtkdoc-scanobj'. This was used to introspect gtk-objects. The makefile fragments shipped with gtk-doc aren't calling this for years (since gtkd

Re: What is the license of generated files?

On 02/03/2014 08:18 PM, Tobias Mueller wrote: > On Sat, Feb 01, 2014 at 12:04:09PM +0100, Stefan Sauer wrote: >> So, ho do we do this practically? we could replace the original files >> with new files, put them into a subdir and add a COPYING note there that >> declares

Re: spring cleaning in gtk-doc for next-next verison (1.21)

tmpl dirs json-glib has stale tmpl dirs librsvg has stale tmpl dirs pango has stale tmpl dirs telepathy-glib has stale tmpl dirs Stefan On 02/01/2014 11:58 AM, Stefan Sauer wrote: > hi, > > while a gtk-doc 1.20 is brewing with some awesome stuff coming, I like > to remove some legacy

Re: How to exclude C files from doc parsing ?

On 02/06/2014 12:36 PM, Tim Ruehsen wrote: > Hi, > > I have a C file generated by the 'flex' utility. It contains comments like > > /** bla > */ > > which disturb gtk-doc: > > ../../libmget/css_tokenizer.c:2627: warning: Symbol name not found at the > start of the comment block. > ../../libmget/cs

ANNOUNCE: gtk-doc 1.20

mitris Spingos Hib Eris Matthias Clasen Philip Chimento Philip Withnall Rafael Ferreira Rico Tzschichholz Ryan Lortie Sebastian Rasmussen Sébastien Wilmet Stefan Sauer Stef Walter William Jon McCann Zbigniew Jędrzejewski-Szmek Stefan ___ gtk-doc-list mail

Re: Resolving cross-references among components

On 11/18/2012 10:59 PM, David Nečas wrote: > On Sun, Nov 18, 2012 at 09:44:27PM +0100, Stefan Sauer wrote: >> I can't add anything here. Do you have a case where this happens? > It should happen everywhere. For instance, Gdk references Gtk+ symbols > dozens of times. Why al

small incompatible change in gtk-doc 1.20 wrt |[]| markdown

hi, we discovered that change c4d09c7c95c45a1226e83f5ddd7d0f4ce2b1a1a9 which has been release as part of gtk-doc 1.20 causes a regression for a use that worked so far. The |[ ... ]| syntax is a shortcut for ... . Now this is automatically wrapped as CDATA which is convenient as one does not need

upcoming gtk-doc-1.21 wont support freeform returns docs.

hi, TL;DR https://bugzilla.gnome.org/show_bug.cgi?id=678094 So far gtk-doc included a heuristic that accepted the last paragraph of a body doc-blob as return documentation if it started with "Return(s)". As this can be ambiguous with a desired "Returns: " block, we added a warning for the cases t

Re: Incompatible .devhelp2 files

On 11/09/2014 09:57 PM, David Nečas wrote: > Hello, > > I would like to know how things such as > > https://bugzilla.redhat.com/show_bug.cgi?id=1090204 This should be fixed in gtkdoc-depscan I think. We we're certainly lacking regession tests and beta testers here. > https://bugzilla.redhat

gtk-doc-1.22 change wrt to tmpl builds

Hi, The upcoming gtk-doc-1.22 release will switch the default makefile flavour from "legacy" to "no-tmpl". If your configure.ac had a line such as GTK_DOC_CHECK([1.XX]) without any args you were using a doc build that includes the deprecated 'tmpl' build step. If you the tmpl directory is not comm

Re: gtk-doc-1.22 change wrt to tmpl builds

On 05/13/2015 05:50 PM, Milan Crha wrote: > On Mon, 2015-05-11 at 11:19 +0200, Milan Crha wrote: >> I'm trying to build evolution-data-server 3.16.2 against gtk-doc-1.22 >> and it fails [1]. It has its configure.ac with this line: >>GTK_DOC_CHECK([1.14],[--flavour no-tmpl]) >> thus should not b

Re: Field description is missing in source code comment block.

On 07/03/2015 12:59 PM, Takao Fujiwara wrote: > When I try to build xml, I got the following error about > IBusPropList::properties: > > ../../../src/ibusproplist.h:73: warning: Field description for > IBusPropList::properties is missing in source code comment block. > > https://github.com/ibus/i

Re: GtkLinkButton signal needs minimum GTK+ requirements

On 07/29/2015 12:39 PM, Igor Korot wrote: > Stefan, > > On Wed, Jul 29, 2015 at 6:09 AM, Stefan Sauer wrote: >> On 07/28/2015 12:47 PM, Igor Korot wrote: >>> Hi, ALL, >>> Is this an oversight? I don't see this minimum GTK+ version for that >>>

Re: GtkDoc error in cmake

Am 11.07.2016 um 06:43 schrieb Hiba Alfarsi: > Good morning Sam > > Did you able to solve the problem? or can you guide me to solve it by myself > ?! > I am waiting your reply Sam asked you to attach the full log. Stefan > > Hiba > > On Fri, Jul 1, 2016 at 2:51 PM, Hiba Alfarsi

Fwd: gtk-doc 1.26

(UTC) From: Stefan Sauer Reply-To: desktop-devel-l...@gnome.org To: FTP Releases About gtk-doc = GTK-Doc is used to document C code. It is typically used to document the public API of libraries, such as the GTK+ and GNOME libraries, but it can also be used to doc

gtk-doc output options

Since people regular illy complain about the slowness of gtk-doc I'd like to evaluate some options. First the slowness is due to using the docbook-xsl stylesheets to produce html/pdf and optionally man pages. One main to get a huge speedup would be to drop the whole docbook toolchain and generate t

Re: Properties with Gtk-doc

On 11/20/2017 09:37 PM, cecashon--- via gtk-doc-list wrote: > Hi doc devs, > > I have been experimenting with introspection and gtk-doc. Most things > are working very well. The widget functions can be used from python, > perl and java script. Very nice. I don't seem to be able to get > gtk-doc to

Re: Document function declarations in header

On 01/29/2018 06:19 PM, Aleksandr Slobodeniuk wrote: > Hi everyone! >   > I'm trying to generate HTMLs from one .h file, that describes some API. > In result HTML I see there's no functions, only described structs and > enums. >   > Is it possible to generate documentation, if "documentation commen

Re: Document function declarations in header

_" in Makefile.am. Stefan > --  > Atentamente, > Aleksandr Slobodeniuk > tel: +34 661 674 116 >   >   >   >   >   > 31.01.2018, 18:32, "Stefan Sauer" : >> On 01/29/2018 06:19 PM, Aleksandr Slobodeniuk wrote: >>> Hi everyone! >>>   >>> I'm

Re: Strange (for me) warnings during doc generating

On 03/14/2018 10:38 AM, Gergely Polonkai wrote: > Hello, > > when genering docs for my project > (https://github.com/gergelypolonkai/matrix-glib-sdk), I get some > strange warnings (line numbers refer to the commit > 8d95dd913cbc3fff4475b85a123bed636cc87739 which I conveniently tagged > with the gt

Re: Union in struct

On 02/05/2018 04:34 PM, Aleksandr Slobodeniuk wrote: > Hi again! > > I've tried to submit a bugs to bugzilla, but couldn't find gtk-doc > project there (strange, yes, I submitted bugs on Gnome Bugzilla before). Here you go: https://bugzilla.gnome.org/enter_bug.cgi?product=gtk-doc > > So, I'll send

Dropping python 2.7 support in gtk-doc (requiring python 3.X)

Hi, Having support for both python 2.7 and python 3.X in gtk-doc makes the code ugly and is beyond what I can test. I am considering to require python >=3.4 für the next gtk-doc release. Would that be a problem for anyone? To also give some extra motivation - Since a few month I am working on gtk

Re: Dropping python 2.7 support in gtk-doc (requiring python 3.X)

On 03/30/2018 02:28 PM, David Nečas wrote: > On Fri, Mar 30, 2018 at 01:24:06PM +0200, Stefan Sauer wrote: >> To also give some extra motivation - Since a few month I am working on >> gtkdoc-mkhtml which is a pure python drop-in replacement for >> gtkdoc-mkhtml+gtkdoc-fixxr

gtk-doc moved to gitlab

hi, the sources and bugs have been migrated to (thanks Carlos!): https://gitlab.gnome.org/GNOME/gtk-doc you can update your existing checkouts doing: # if you are a gnome developer git remote set-url origin g...@gitlab.gnome.org:GNOME/gtk-doc.git # or git remote set-url origin https://gitlab.g

Re: [autotools] gtk-doc.m4 - cross compile support

On 10/10/2018 09:18 AM, John Cupitt via gtk-doc-list wrote: > On Wed, 10 Oct 2018 at 07:39, Fontana Nicola wrote: >> Il giorno mer, 10/10/2018 alle 09.20 +0300, Alon Bar-Lev ha scritto: >>> BTW: just a thought, if you compile on demand the scanobj, then you >>> can use the build CC/LD and it will

gtkdoc help wanted tickets

hi, for the near future I won't be able to work on gtk-doc feature requests. I am cleaning up the code to make it testable and converting the silly integrations tests into unit tests. This will help to get pasring issues/bugs under control with less chance of causing regressions. Here are the cur

Re: gtkdoc help wanted tickets

On 11/30/2018 03:14 PM, Bastien Nocera wrote: > On Fri, 2018-11-30 at 13:08 +0100, Stefan Sauer wrote: >> hi, >> >> for the near future I won't be able to work on gtk-doc feature requests. >> I am cleaning up the code to make it testable and converting the silly

preparing for a new gtk-doc release

hi, did anyone try the new toolchain yet? In configure.ac all you need to do is: -GTK_DOC_CHECK([1.14]) +GTK_DOC_CHECK([1.29],[--flavour no-xslt]) for meson/cmake I have no idea and would glady take patches. The advantage of the new toolchain is that you won't need xsltproc + docbook-stylesheets

Re: Bug in Tutorial / Documentation: Missing h-files

Hi Chris, On 11.09.19 07:09, notebook via gtk-doc-list wrote: > Hello Devs: > > On this site: > https://developer.gnome.org/gtk3/stable/ch01s04.html > > there are reference to h-files like exampleapp.h. But their content is > never listed on the website. This renders the tutorial rather useless. >