C header template with doxygen

header-template.h

/**
 * @file      [file name].h
 * @authors   [Author]
 * @copyright [Copyright holder]
 *
 * @brief [description]
 */

#pragma once

I have this simple script for generating a Doxygen header that I use. You can modify it to add the copyright fields.

#!/bin/bash

set -e

input_file=$1
todays_date=$(date "+%Y-%m-%d")
git_user_email=$(git config --list | grep user.email | cut -f2 -d"=")
git_user_name=$(git config --list | grep user.name | cut -f2 -d"=")
filename=$(basename -- $input_file)

echo "/**"
echo "* @file $filename"
echo "* @date $todays_date"
echo "* @author $git_user_name <$git_user_email>"
echo "* @brief "
echo "*/"

It uses your Git config setup to grab your name and email address. You run it like:

$ ./generate_doxygen_header.sh misc-devel/parse_git_externals_into_chrome_bookmarks.py

and it returns:

/**
* @file parse_git_externals_into_chrome_bookmarks.py
* @date 2023-06-20
* @author Littles, Raleigh <[email protected]>
* @brief 
*/