From mboxrd@z Thu Jan 1 00:00:00 1970 X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on polar.synack.me X-Spam-Level: X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00 autolearn=ham autolearn_force=no version=3.4.4 X-Google-Thread: a07f3367d7,9124c8b7efcea462 X-Google-Attributes: gida07f3367d7,public,usenet X-Google-NewGroupId: yes X-Google-Language: ENGLISH,ASCII-7-bit Path: g2news1.google.com!news1.google.com!npeer02.iad.highwinds-media.com!news.highwinds-media.com!feed-me.highwinds-media.com!post02.iad.highwinds-media.com!news.flashnewsgroups.com-b7.4zTQh5tI3A!not-for-mail Newsgroups: comp.lang.ada Subject: Re: Ada and Doxygen References: <4b84fb09$0$6579$9b4e6d93@newsspool3.arcor-online.net> <45d5f4b8-8e8e-43ef-94df-0558262cd978@g11g2000yqe.googlegroups.com> <68cf6a9d-240b-4970-98f0-fee32795f00d@e7g2000yqf.googlegroups.com> From: Stephen Leake Date: Sat, 27 Feb 2010 09:25:16 -0500 Message-ID: User-Agent: Gnus/5.11 (Gnus v5.11) Emacs/22.2 (windows-nt) Cancel-Lock: sha1:YDkgEEwfXL/vQoY1KTnMHp3/mnM= MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Complaints-To: abuse@flashnewsgroups.com Organization: FlashNewsgroups.com X-Trace: 8ca234b892b81e197caa715394 Xref: g2news1.google.com comp.lang.ada:9344 Date: 2010-02-27T09:25:16-05:00 List-Id: Vadim Godunko writes: > We are known current GNAT's style for comments. Each package has a > description at the specification and each entity also has a > description below its declaration in the specification. GPS shows such > a comment in tooltips. > > Qt's uses another way. There are no comments in headers at all. This > makes header files clean - it is very important for overview of the > class. You are implying that the comments get in the way of an "overview". That makes sense; if you are mostly familiar with a package, but forget the exact names, or want to see if a particular function is there, it would be useful to have a short list of just the functions. Emacs supports this by hiding selected parts of the file; all comments, for example. See hs-minor-mode (hs for hide-show). That also hides blocks in bodies, but apparently it doesn't currently understand Ada for that feature. I don't like the current keybindings, but that's easy to fix. > All comments are placed in the implementation files. Special tool > parse both headers and implementation files, construct list of > classes, its methods/signals/slots/etc; then parse implementation > files and extracts description for each entity; links > classes/methods/ slots/signals with their descriptions and construct > complete documentation in HTML form, which can be hosted somewhere > or read by browser. After that, another tool pack this documentation > and all related resources into the one "database" which can be > registered in the Qt Assistant to extend useful of it (Qt Assistant > allows to do full text search for example). And even it is not a > last step, when you use Qt Creator (IDE for Qt) and stay somewhere > in the code, you can click key and Qt Creator opens description of > class/method you stay on in the Qt Assistant documentation. It is > very fast and useful! This could be done for the Ada code by a tool similar to AdaBrowse, and an Emacs key binding could pop up Qt Assistant from Ada code. If I start using QtAda more, I'll be motivated to do this. -- -- Stephe