1/11/2024 0 Comments Doxygen custom tags![]() * Implements hook_aggregator_fetch_info(). The patch is full of stuff like this: /** This theme is an attempt to update the visuals of Doxygen without changing its overall layout too much. I really like how the Doxygen HTML-documentation is structured But IMHO it looks a bit outdated. However, one note: to be in line with the rest of our function standards, the proposal in #17 needs to be: /** Doxygen Awesome is a custom CSS theme for Doxygen HTML-documentation with lots of customization parameters. I am sorry! Without the summary of what you're trying to do in #17, just looking at the patch, I didn't understand the merits of what you were proposing. There are 1003 hook implementations in Drupal core which is a lot, but I think it is dooable :-) and worth to do it, since Drupal API is the basement. The only down side of this approach which I can see is that if the original hook's summary will change we may need to change also the summary in some of its implementations, but with we will have better idea where we need to provide the change and also we know search and replace magic. You can Fold / Unfold comments blocks from the Command Palette or using Sublime Text standard shortcuts. If we go this way, the next step should be fixing the one line summaries and placing the in the right order in the comment block since some hook implementations already have them (see example 1) and if the hook doesn't do something special I will simply add the hook's one-line summary it makes more sense for me than repeating "implements" twice (see example 2). Doxygen file only (.dox) You can move from a ref tag to the referenced page or section using the gotodefinition command (press F12 using Sublime Text default key bindings) Fold / Unfold comments. * Define all blocks provided by the module. ![]() Or B) if the hook doesn't something special we can just simply repeat one-line summary from the original hook, so the summary will saying something meanigfull. "Duplicated" default comment looks really weird, possible solutions: A) removing the standardized sentence, like in the original patch /** * Queues news feeds for updates once their refresh interval has elapsed.īased on the discussion above in this issue I think it should be /** The patch currently includes some chunks which are not nice, like these: I think there is a way: What about repeating the summary if the function don't do nothing special? I agree with catch and tstoeckler that there should be always some one-line summary, but I also agree with sun that we should avoid duplication if possible. It means I've to do something like the following depending on the mode.Since I have prepared regex routines in my IDE to provide The Great Migration I created also the alternative patch where are addons, not replacements of the original "Implements." summaries. It can be used to query and change the tags (see Including content based on tags). Doxygen is the industry standard in SW development for auto-generating documentation from code. What I'm looking for is how to adjust the css to have the same behavior. There is a special object named tags available in the config file.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |