From owner-freebsd-hackers Fri Mar 12 15:16:47 1999 Delivered-To: freebsd-hackers@freebsd.org Received: from picnic.mat.net (picnic.mat.net [206.246.122.133]) by hub.freebsd.org (Postfix) with ESMTP id 6E48414CBA for ; Fri, 12 Mar 1999 15:16:40 -0800 (PST) (envelope-from chuckr@mat.net) Received: from localhost (chuckr@localhost) by picnic.mat.net (8.9.3/8.8.5) with ESMTP id SAA00578; Fri, 12 Mar 1999 18:14:47 -0500 (EST) Date: Fri, 12 Mar 1999 18:14:47 -0500 (EST) From: Chuck Robey To: "Jordan K. Hubbard" Cc: Steven Young , freebsd-hackers@FreeBSD.ORG Subject: Re: visual config editor In-Reply-To: <24926.921279593@zippy.cdrom.com> Message-ID: MIME-Version: 1.0 Content-Type: TEXT/PLAIN; charset=US-ASCII Sender: owner-freebsd-hackers@FreeBSD.ORG Precedence: bulk X-Loop: FreeBSD.ORG On Fri, 12 Mar 1999, Jordan K. Hubbard wrote: > > Hm, well now. The help text would be pretty easy to put in the LINT > > file - probably something simple like just putting a comment block above > > each option, and that will be imported as the help text. However, as > > I think the comment block should contain some sort of standardized > "record" of not just help text, but possible values for certain fields > (or information which denotes that they're display-only, or whatever). Could I make a suggestion? Lint isn't a C source file, but there's a new style coming into use, starting in the Java world, but moving slowly to C and C++. It's exemplified by Java's Javadoc, or for C/C++, see the port devel/doc++. This allows one to embed tags, do even a little formatting. I'm not really convinced it's the absolutely best for this particular application (so I'd understand if you said yeccch! here) but I'd sure like to get some example of this style documentation into the FreeBSD sources. I could describe it, but I think it's better if you go look at devel/doc++. The automatically generated docs I've made in Java, well, they're simply awesome, generated right from the source code. ----------------------------+----------------------------------------------- Chuck Robey | Interests include any kind of voice or data chuckr@glue.umd.edu | communications topic, C programming, and Unix. 213 Lakeside Drive Apt T-1 | Greenbelt, MD 20770 | I run picnic (FreeBSD-current) (301) 220-2114 | and jaunt (Solaris7). ----------------------------+----------------------------------------------- To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-hackers" in the body of the message