any way to suppress - prepending \brief to \details in class & file members ?
"Monique Semp" <[email protected]>
| Newsgroups | gmane.text.doxygen.general |
|---|---|
| Message-ID | <0E65FA6959954D4C9889532BC8A6D1DE@WQIMJS> |
Hello, Doxygen users, I’m wondering if there’s any way to suppress the standard behavior of the \brief and \details commands for class & file members? As it says in the documentation, https://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdbrief, the \brief is prepended to the \details. But I really, really wish that when there is a \details command, only it would appear in the output (without the prepended \brief content). Details: My problem (using Doxygen 1.8.10, but I don’t think the version is relevant) is that I’ve started a project to convert a huge amount of DoxyS-commented code to Doxygen comments, and DoxyS does not include the \brief content for members if there is also a \details section. And so way back when, when I created this body of DoxyS-commented code, I pretty much repeated the info from the \brief in the \details, but in a full-sentence format vs. the “phrase” format of the \brief. That is, for \brief I’d say, “Register a callback.” But for \details, I’d say, “This function registers a callback for component XYZ.” But now I’m porting everything (all ~150 files, with well more than a thousand functions/callbacks) to Doxygen. (I want to port it because DoxyS is not an active project; it has performance issues with groups; and it doesn’t support LaTeX, which I want to generate a good PDF.) And so the member descriptions look awful with the \brief prepended to the \details. It’s a pretty giant conversion project (lots of the tags are the same, but the text formats and autolinking are all different), but a lot is scriptable. But editing the \details to not repeat what’s in the \brief will require human interaction. Thanks for any ideas, -Monique ------------------------------------------------------------------------------ Monitor Your Dynamic Infrastructure at Any Scale With Datadog! Get real-time metrics from all of your servers, apps and tools in one place. SourceForge users - Click here to start your Free Trial of Datadog now! http://pubads.g.doubleclick.net/gampad/clk?id=241902991&iu=/4140 _______________________________________________ Doxygen-users mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/doxygen-users