From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: docstrings and elisp reference Date: Tue, 06 Jun 2017 18:03:36 +0300 Message-ID: <8360g99n07.fsf@gnu.org> References: <0BB64F35-233A-471F-B99F-51F96C4E6CCB@gmail.com> Reply-To: Eli Zaretskii NNTP-Posting-Host: blaine.gmane.org X-Trace: blaine.gmane.org 1496761439 7870 195.159.176.226 (6 Jun 2017 15:03:59 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Tue, 6 Jun 2017 15:03:59 +0000 (UTC) Cc: emacs-devel@gnu.org To: Jean-Christophe Helary Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Tue Jun 06 17:03:55 2017 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dIG1Q-0001jS-Tr for ged-emacs-devel@m.gmane.org; Tue, 06 Jun 2017 17:03:53 +0200 Original-Received: from localhost ([::1]:38753 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dIG1W-0008WP-3X for ged-emacs-devel@m.gmane.org; Tue, 06 Jun 2017 11:03:58 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:43127) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dIG1L-0008Uo-Jm for emacs-devel@gnu.org; Tue, 06 Jun 2017 11:03:48 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dIG1H-0005sx-Nx for emacs-devel@gnu.org; Tue, 06 Jun 2017 11:03:47 -0400 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:60540) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dIG1H-0005st-Kj; Tue, 06 Jun 2017 11:03:43 -0400 Original-Received: from 84.94.185.246.cable.012.net.il ([84.94.185.246]:2536 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1dIG1G-0003CD-V1; Tue, 06 Jun 2017 11:03:43 -0400 In-reply-to: <0BB64F35-233A-471F-B99F-51F96C4E6CCB@gmail.com> (message from Jean-Christophe Helary on Tue, 6 Jun 2017 14:10:19 +0900) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 2001:4830:134:3::e X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.org gmane.emacs.devel:215473 Archived-At: > From: Jean-Christophe Helary > Date: Tue, 6 Jun 2017 14:10:19 +0900 > > Having a mechanism that generates automatic documentation (a la javadoc) would be extremely valuable. It could be valuable, but IMO only if we exercise a lot of discipline in producing those comments. Because every project which uses this methodology that I looked at ends up providing _abysmally_ inadequate documentation. As one very typical example, look at the GTK docs, e.g. here: https://developer.gnome.org/gtk4/stable/GtkWindow.html