Re: Best way to extract info from C files?

[Jude DaShiell <jdashiel@panix.com>]

Study sed once you get a script going correctly and you pass sed several
files you'll love the speed it uses to get the work done.  While I was
working I managed to break 106 different files.  I figured with no
mistakes I could fix them in two weeks manually and no mistakes never
happens on manual jobs.  So I studied sed and threw the 106 files at sed
and sed took care of that job for me in 6 minutes and did it accurately.


--
 Jude <jdashiel at panix dot com>
 "There are four boxes to be used in defense of liberty:
 soap, ballot, jury, and ammo.
 Please use in that order."
 Ed Howdershelt 1940.

On Tue, 13 Feb 2024, Stefano Ghirlanda 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!
>
>