From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp2.migadu.com ([2001:41d0:303:e224::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms8.migadu.com with LMTPS id SCy6F8eWy2WstwAAe85BDQ:P1 (envelope-from ) for ; Tue, 13 Feb 2024 17:20:23 +0100 Received: from aspmx1.migadu.com ([2001:41d0:303:e224::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp2.migadu.com with LMTPS id SCy6F8eWy2WstwAAe85BDQ (envelope-from ) for ; Tue, 13 Feb 2024 17:20:23 +0100 X-Envelope-To: larch@yhetil.org Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=gmail.com header.s=20230601 header.b=Ht0TDCwV; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org" ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1707841223; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post:dkim-signature; bh=NPOqVQraI1VKMJbNm/GgM7QAcEoL2sgnr8MSz9Z6Ji8=; b=q3P2AHn3+NtRI44xH6HemakF11kzgmY9XTTp/+ybG5R53Om59qJjFZi7PtwhpfFaxcIvOo ZAMRvSg9/kmVGDoxCRPeMJq65zYguFLzls7mxNszu9OeO52hHfo7PY8+Gf8+ie29IRHuaT qwKqQgY+82mTL+rBLdCMj4DKfZgPw6c+vHTIRr80Nbz7qlxdApx6ss4wtk0HvZamA/dMU2 SpZ4MxtK03N+5NJtpJXS89+dvtDNiQxugM2JZaF7l/pwPOa06Kj1QPvPMiayDFo6EKDCNo MRxi6cNDsFCW4q3djD+U1C0nWRGsA1gPpJmwiOWQ0oSJSUyFd6/XvSMR368IIw== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=gmail.com header.s=20230601 header.b=Ht0TDCwV; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org" ARC-Seal: i=1; s=key1; d=yhetil.org; t=1707841223; a=rsa-sha256; cv=none; b=QRItXOBRqp7zt2szAf8AlaFwC/ljphL2xY8Aqz8+bBCuks2O6hJquEht2a/gJaKQjPAmHU v7O6GLol/IZYSyVJ8tbhXx8luFP2iEl0NQUfUWJ5fz8SjZAkcpphfXGlA+OuZefMeC4u5i VeOboFwLBRiVsBPHb7VCqexGHe2OyWx6UnJKEQCQuqsPuAw5Xl8NbyzDY4ROm9VLuYDCbW t8PDUflK2EEtObZi3POKNojrlJVeU0M5nuV0HsV2OIf3yPMyNKFxymVxfYjFJN6qciyTQ+ hQKtZ42wTMmzGOJhLQ/B/LZNHpjns3keQZiTpnNFp7B5Yb5d6iLKaiFxCQoKzQ== Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 4681760508 for ; Tue, 13 Feb 2024 17:20:23 +0100 (CET) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rZvVE-0005z9-4l; Tue, 13 Feb 2024 11:19:24 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rZvVC-0005z0-Mp for emacs-orgmode@gnu.org; Tue, 13 Feb 2024 11:19:22 -0500 Received: from mail-lj1-x231.google.com ([2a00:1450:4864:20::231]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1rZvVA-0002H1-TD for emacs-orgmode@gnu.org; Tue, 13 Feb 2024 11:19:22 -0500 Received: by mail-lj1-x231.google.com with SMTP id 38308e7fff4ca-2d0bdb8061fso8792591fa.1 for ; Tue, 13 Feb 2024 08:19:20 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1707841158; x=1708445958; darn=gnu.org; h=content-transfer-encoding:to:subject:message-id:date:from :in-reply-to:references:mime-version:from:to:cc:subject:date :message-id:reply-to; bh=NPOqVQraI1VKMJbNm/GgM7QAcEoL2sgnr8MSz9Z6Ji8=; b=Ht0TDCwVvPaiYuPOoKtKNkR/VftQm/5/I+C+IVO7WIRhwpWXTmdyBPfXvnUtneBx5r tKIc9F1op/43mZj4EmzszucAa0jUks5n28G1jL7HWLCPfor0qOrr31xz9A0T/MrKsLHs R2ieUjsiWr5NFDxdhHoeq76VckZ2AwVwv3QWHajSvQL2ir4eUzYDc0q7JvgRv0vmTpTr NJ0rNtKi72Ej9DJAIrDk/2q/Ld6iFlUy+JOjSJUTXtmWoo0eYnquyginKlHh8w6f1dCv eIRzDTio+D3xiiDGFouzVqQ2iFHhBL9pK30TCX0wAVXbHL+jg6DftxEPfct+Qh7sleDE I9bw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1707841158; x=1708445958; h=content-transfer-encoding:to:subject:message-id:date:from :in-reply-to:references:mime-version:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=NPOqVQraI1VKMJbNm/GgM7QAcEoL2sgnr8MSz9Z6Ji8=; b=jbvzhyFXFSPb+BWyIV2m26EaIzrgsJReeJru5XgwnZTHmsMbgStIA5ZJwBt/F/NFCj 4PKqoz3T/8GVo8vG5N2GAKmtaUwHYAsqGbwKPyYq4zj+f8cXXDvIEF/hmJkdk6pbustF Fi0k3nYneL/HMBlmqaIJm38x/Cb8mWVwBA+Pirg2G8HhP5MhzXoEuPnuP2jBnHbwjCH9 OMTIFb+FGGGVL/XI+MOZyI10BF0QhZbfI4vFia7b7xH84779HBg4S5+sT6gk56oy0it2 hk0f/nmxMpGNomkthw7u2tdBMeiqiG44AKt05cFhcV7iJvDb8u8XCWvO7M7+q/fOGiQB snZA== X-Gm-Message-State: AOJu0Yztj3IgZwoKu48AOk3GkG2UtORNSsh6vpy+eC3MDMFRL+kNotU6 2RmFVApxjSk9CrrGjLc4s8Dl70+/DyPvBdIGO3aiHTnibqDn/QotfWpRMzCO/TSuh3zE9mbViVV AK/0uBBLFxQZTPDCZDoASfTlrETINhysh X-Google-Smtp-Source: AGHT+IFubokFIylOZur9pJOWatbAoXD5keUuTzT2+U5QZxUfphSsSHUd5wlipaF+lY3tkg1tlUVYt1ISPCEmilZag7g= X-Received: by 2002:a2e:b043:0:b0:2d0:aafa:fcc9 with SMTP id d3-20020a2eb043000000b002d0aafafcc9mr68065ljl.4.1707841157888; Tue, 13 Feb 2024 08:19:17 -0800 (PST) MIME-Version: 1.0 References: In-Reply-To: From: Stefano Ghirlanda Date: Tue, 13 Feb 2024 08:18:40 -0800 Message-ID: Subject: Re: Best way to extract info from C files? To: emacs-orgmode@gnu.org Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Received-SPF: pass client-ip=2a00:1450:4864:20::231; envelope-from=sg19721222@gmail.com; helo=mail-lj1-x231.google.com X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_ENVFROM_END_DIGIT=0.25, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-orgmode@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: emacs-orgmode-bounces+larch=yhetil.org@gnu.org X-Migadu-Flow: FLOW_IN X-Migadu-Country: US X-Migadu-Spam-Score: -8.10 X-Spam-Score: -8.10 X-Migadu-Queue-Id: 4681760508 X-Migadu-Scanner: mx12.migadu.com X-TUID: tel5zq9jQUSG 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=E2=80=AFAM 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! > > -- > Stefano Ghirlanda > CTO, DataWorks - https://dataworks.consulting > Guest Professor - Stockholm University Centre for Cultural Evolution --=20 Stefano Ghirlanda CTO, DataWorks - https://dataworks.consulting Guest Professor - Stockholm University Centre for Cultural Evolution