emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
doomemacs/modules/ui/hl-todo
History
Henrik Lissner 88844e9cec docs: simplify internal docs links 
Fewer links means less confusion.

- Merge doom-issue and doom-commit links into doom-ref (for auto-linking
  Issue/PR/commit references).
- Merge doom-module-source and doom-docs-source links into doom-source.
- Rename doom-report-issue to doom-report.
- Use '!' as the icon for module issues link.
- Remove doom-repo (replaced with "doom:*" in :lang org module).
- Add doomdir and emacsdir links to :lang org module.
2021-11-21 20:04:28 +01:00
..
config.el refactor: rename orig-fn arg in advice to fn 2021-08-04 01:53:12 -04:00
packages.el bump: :app :checkers :config :emacs :term :tools :ui 2021-09-15 17:47:17 +02:00
README.org docs: simplify internal docs links 2021-11-21 20:04:28 +01:00

README.org

:ui hl-todo

← Back to module index ! Issues ↖ Github ± Suggest edits ? Help

Description   unfold

This module adds syntax highlighting for various tags in code comments, such as TODO, FIXME, and NOTE, among others.

Maintainers

Become a maintainer?

Module flags

This module has no flags.

Packages

Hacks

No hacks documented for this module.

TODO Changelog

This module does not have a changelog yet.

Installation

Enable this module in your doom! block.

This module has no external requirements.

TODO Usage

🔨 This module's usage documentation is incomplete. Complete it?

By enabling this module, the following keywords will be highlighted if they occur in code comments:

  • TODO: For things that need to be done, just not today.
  • HACK: For tidbits that are unconventional and not intended uses of the constituent parts, and may break in a future update.
  • FIXME: For problems that will become bigger problems later if not fixed ASAP.
  • REVIEW: for things that were done hastily and/or hasn't been thoroughly tested. it may not even be necessary!
  • NOTE: For especially important gotchas with a given implementation, directed at another user other than the author.
  • DEPRECATED: For things that just gotta go and will soon be gone.
  • BUG: For a known bug that needs a workaround.
  • XXX: For warning about a problematic or misguiding code.

Keybindings

keybind description
]t go to next TODO item
[t go to previous TODO item
SPC p t show all TODO items in a project
SPC s p search project for a string
SPC s b search buffer for string

TODO Configuration

🔨 This module's configuration documentation is incomplete. Complete it?

To add your own ITEMS you would need to configure them using hl-todo-keyword-faces:

;; in $DOOMDIR/config.el
(after! hl-todo
  (setq hl-todo-keyword-faces
        `(("FOO"  . ,(face-foreground "MY COLOUR HEX CODE"))
          ("BAR" . ,(face-foreground 'my-colour-var)))))

Troubleshooting

There are no known problems with this module. Report one?

Frequently asked questions

This module has no FAQs yet. Ask one?

TODO Appendix

🔨 This module has no appendix yet. Write one?