emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Stefano Ghirlanda <dr.ghirlanda@gmail.com>
To: emacs-orgmode@gnu.org
Subject: Re: Best way to extract info from C files?
Date: Tue, 13 Feb 2024 08:18:40 -0800	[thread overview]
Message-ID: <CAK_gY-TuDLCSDQOijH0hhM0MkyeP3tuqG7F4ZY1LXk4rakNuTg@mail.gmail.com> (raw)
In-Reply-To: <CAK_gY-QWVy4S=fwyTm37mWqkgkkt81Nu5Jo5YZ=KCAwPvOVwJw@mail.gmail.com>

And I have just learned about org-ctags from another post on the
list... Would that be an option?

On Tue, Feb 13, 2024 at 7:58 AM Stefano Ghirlanda
<dr.ghirlanda@gmail.com> wrote:
>
> Hi all!
>
> I'm trying to build a simple code documentation tool for org-mode, so
> I'm looking for ways to get information from C files (to begin with,
> ideally it will be easy to add other languages). Things like function
> prototypes, struct definitions, etc. What would be the best tool for
> this? My search has come up with things like lsp-mode, semantic, etags
> but I have no experience with any of these. What would be easiest to
> work with / setup, and have the necessary functionality? Or should I
> just write my own parsing code?
>
> More specifically, my initial goal is to be able to parse things in a
> format similar naturaldocs.org, for example:
>
> // Function: This is a brief description.
> // Parameters:
> // - x: The first parameter
> // - y: The second parameter
> // Return: A value
> int my_function( int x, int y );
>
> and transform this into something like:
>
> * Documentation
>
> ** my_function
>
> This is a brief description
>
> | Parameters: |                                      |
> | x                   | The first parameter       |
> | y                   | The second parameter |
> |----------------------------------------------------|
> | Return          | A value                         |
>
> To be improved iteratively :)
>
> Thanks!
>
> --
> Stefano Ghirlanda
> CTO, DataWorks - https://dataworks.consulting
> Guest Professor - Stockholm University Centre for Cultural Evolution



-- 
Stefano Ghirlanda
CTO, DataWorks - https://dataworks.consulting
Guest Professor - Stockholm University Centre for Cultural Evolution


  reply	other threads:[~2024-02-13 16:20 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-02-13 15:58 Best way to extract info from C files? Stefano Ghirlanda
2024-02-13 16:18 ` Stefano Ghirlanda [this message]
2024-02-13 18:59 ` Jude DaShiell
2024-02-20 11:05 ` Ihor Radchenko
2024-02-21  2:15   ` Stefano Ghirlanda

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

  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=CAK_gY-TuDLCSDQOijH0hhM0MkyeP3tuqG7F4ZY1LXk4rakNuTg@mail.gmail.com \
    --to=dr.ghirlanda@gmail.com \
    --cc=emacs-orgmode@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 public inbox

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

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