emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: docstrings and elisp reference


From: Eli Zaretskii
Subject: Re: docstrings and elisp reference
Date: Tue, 06 Jun 2017 18:03:36 +0300

> From: Jean-Christophe Helary <address@hidden>
> 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



reply via email to

[Prev in Thread] Current Thread [Next in Thread]