After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 684665 - Stop using template files
Stop using template files
Status: RESOLVED FIXED
Product: atk
Classification: Platform
Component: docs
unspecified
Other Linux
: Normal normal
: ---
Assigned To: ATK maintainer(s)
ATK maintainer(s)
Depends on:
Blocks:
 
 
Reported: 2012-09-23 16:51 UTC by Alejandro Piñeiro Iglesias (IRC: infapi00)
Modified: 2013-08-12 19:13 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Alejandro Piñeiro Iglesias (IRC: infapi00) 2012-09-23 16:51:10 UTC
In old times projects using gtk-doc had a template files to have the skeleton of the documentation. These days most of them (like clutter and gtk+) don't use them anymore.

In general I feel that the documentation structure on both gtk+ and clutter are cleaner. For example, right now the documentation of atk signals and the description of each object (SECTIONS) are written on those templated documents, but the documenation of atk properties and methods are written at the source code. It would be cleaner to have just one place (.s source file) to write the API reference, and keep the fillers at atk/doc to explain the high level purpose of the library, or specific documentation, like the hypothetical guidelines.
Comment 1 Alejandro Piñeiro Iglesias (IRC: infapi00) 2013-08-12 19:13:59 UTC
This commit removes all the template files from git:

commit 0f1e31ad2451b1e00f631e217d9d29d306404f2d
Author: Alejandro Piñeiro <apinheiro@igalia.com>
Date:   Mon Aug 12 17:07:46 2013 +0200

    doc: removing several .sgml files and fixing gtk-doc warnings


Although I talk about other documentation updates on the description, that can be managed on other bug. The main reason this bug was created (stop to use .sgml files) is solved.

Closing  bug.