From: Michael Hannon <jm_hannon@yahoo.com>
To: Sebastien Vauban <wxhgmqzgwmuf@spammotel.com>,
"emacs-orgmode@gnu.org" <emacs-orgmode@gnu.org>
Subject: Re: Babel vs. Doxygen?
Date: Thu, 29 Mar 2012 08:50:29 -0700 (PDT) [thread overview]
Message-ID: <1333036229.29253.YahooMailNeo@web161901.mail.bf1.yahoo.com> (raw)
In-Reply-To: <80hax7bzpk.fsf@somewhere.org>
On Thursday, March 29, 2012 at 1:04 AM Sebastien Vauban wrote:
> Michael Hannon wrote:
>> Greetings. I just ran across an article about Doxygen [1], and I'm
>> trying to
>
> Forgotten footnote?
Hi, Seb. Yep, the footnote appears in my draft message but not in the final
message. Don't know what happened. I'm sure this isn't a mystery to anybody,
but here's the reference:
[1] http://www.doxygen.org/
>> understand if there's any intersection between Doxygen/Roxygen and Org mode
>> Babel, both of which seem to have literate programming as a goal. Any
>> thoughts about this? Thanks.
>
> It just is completely different: with Babel, you put code blocks inside
> documentation to be read by a human.
>
> With Doxygen and the like, you put special comments (for generating doc)
> inside your code. That's the opposite!
>
> You could view it as more or less equal, but it's not. LP allows you to make
> a documentation, and spread code blocks in any order inside it, in the order
> which make more sense for the user to understand your strategy, method, etc.
>
> LP allows you also to write a block of code once, and reuse it (even with
> parameters) in multiple places, avoiding copy/pasted code for languages
> where such a thing is sometimes difficult to avoid (SQL, Makefile, etc.), or
> where avoiding it would make the code even much more complex.
>
> These two last arguments are simply not applicable for Doxygen.
Thanks, this all makes good sense to me. I guess I was basically wondering if
people were routinely using some combination of Doxygen and Org mode -- maybe
including Doxygen markup inside the Org file, then running doxygen on the
tangled output or ... This is evidently not a common/useful way of working.
-- Mike
next prev parent reply other threads:[~2012-03-29 15:50 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-03-29 1:45 Babel vs. Doxygen? Michael Hannon
2012-03-29 8:04 ` Sebastien Vauban
2012-03-29 15:50 ` Michael Hannon [this message]
2012-03-31 14:26 ` Eric Schulte
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=1333036229.29253.YahooMailNeo@web161901.mail.bf1.yahoo.com \
--to=jm_hannon@yahoo.com \
--cc=emacs-orgmode@gnu.org \
--cc=wxhgmqzgwmuf@spammotel.com \
/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.