all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: John Yates <john@yates-sheets.org>
To: help-gnu-emacs@gnu.org
Subject: Hide/show support for C++ triple-slash Doxygen markup?
Date: Sat, 29 May 2010 18:09:23 +0000 (UTC)	[thread overview]
Message-ID: <loom.20100529T200426-537@post.gmane.org> (raw)

I use Doxygen's triple-slash syntax to markup my C++ code.  There are
two important cases which arise:

1) block markup comments which are the sole element on the line and may
   or may not begin flush left; e.g.

class foo
/// A one sentence brief description of foo.  The elaboration can
/// continue on for many lines.
{
    ...
};

void foo::bar
    /// A one sentence brief description of bar.  The elaboration can
    /// continue on for many lines.
    () const
{
    ...
}


2) trailing markup comments which always follow some number of C++
   tokens earlier on the first line but may still spill over onto
   subsequent lines; e.g.

class foo
{
    int  _var1;                 ///< A brief description of _var1.
    int  _var2;                 ///< A brief description of _var2
                                ///< requiring additional lines.
}

void foo::bar
    ( int arg1                  ///< A brief description of arg1.
    , int arg2                  ///< A brief description of arg2
                                ///< requiring additional lines.
    ) const
{
    ...
}


I wonder what hide/show support exists to deal with these conventions.
The most important cases are the block markup comments.  Ideally I would
like to be able to eliminate these altogether, meaning that I would
prefer not to waste a line simply to indicate presence of a folded
block markup comment.  Instead I would like a fringe marker, a la

    http://www.emacswiki.org/emacs/hideshowvis.el

/john





             reply	other threads:[~2010-05-29 18:09 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-05-29 18:09 John Yates [this message]
2010-05-29 20:00 ` Hide/show support for C++ triple-slash Doxygen markup? Thien-Thi Nguyen

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=loom.20100529T200426-537@post.gmane.org \
    --to=john@yates-sheets.org \
    --cc=help-gnu-emacs@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.