Re: Best way to extract info from C files?

[Stefano Ghirlanda]

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