Skip to content
/ doxyfind Public

Simple script to run doxygen from anywhere in the current git repo

Notifications You must be signed in to change notification settings

t-bre/doxyfind

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 

Repository files navigation

doxyfind

  • Finds root of git repo containing current working directory
  • Looks for Doxyfiles in the repo
  • Picks the shortest path to a Doxyfile
  • Runs doxygen in the corresponding directory

Installation

Clone somewhere such as /usr/bin:

cd <installation directory>
git clone https://github.com/t-bre/doxyfind

Add the following to your bash / zsh configuration, replacing <installation directory> with the directory you cloned the repo into:

export PATH="<installation directory>/doxyfind:$PATH"
alias doxyfind="doxyfind.sh"

Restart terminal. Alternatively for bash run source ~/.bashrc or for zsh run source ~/.zshrc

Usage

Anywhere inside a git repo:

doxyfind

Tested on macOS Big Sur with zsh.

About

Simple script to run doxygen from anywhere in the current git repo

Topics

Resources

Stars

Watchers

Forks

Languages