emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: "Sebastien Vauban" <wxhgmqzgwmuf-geNee64TY+gS+FvcfC7Uqw@public.gmane.org>
To: emacs-orgmode-mXXj517/zsQ@public.gmane.org
Subject: Re: Babel vs. Doxygen?
Date: Thu, 29 Mar 2012 10:04:07 +0200	[thread overview]
Message-ID: <80hax7bzpk.fsf@somewhere.org> (raw)
In-Reply-To: 1332985539.87406.YahooMailNeo@web161901.mail.bf1.yahoo.com

Hi Michael,

Michael Hannon wrote:
> Greetings.  I just ran across an article about Doxygen [1], and I'm trying to

Forgotten footnote?

> 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.

Best regards,

Sebastien Vauban

  reply	other threads:[~2012-03-29  8:04 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 [this message]
2012-03-29 15:50   ` Michael Hannon
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:

  List information: https://www.orgmode.org/

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

  git send-email \
    --in-reply-to=80hax7bzpk.fsf@somewhere.org \
    --to=wxhgmqzgwmuf-genee64ty+gs+fvcfc7uqw@public.gmane.org \
    --cc=emacs-orgmode-mXXj517/zsQ@public.gmane.org \


* 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 public inbox


This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).