Skip to content

Instantly share code, notes, and snippets.

@mzipay
Last active February 29, 2024 14:33
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save mzipay/2c16253c401f11887c560f51586e7bd6 to your computer and use it in GitHub Desktop.
Save mzipay/2c16253c401f11887c560f51586e7bd6 to your computer and use it in GitHub Desktop.
Custom Doxygen license and licenseblock/endlicenseblock commands
ALIASES += license="\par License^^"
ALIASES += license{1}="\par \1\n"
ALIASES += licenseblock="\par License^^\parblock^^"
ALIASES += licenseblock{1}="\par \1^^\parblock^^"
ALIASES += endlicenseblock="\endparblock^^"
/*! @file examples.h
*
* Produces implicit "License" title and indented notice of license:
*
* @license Licensed under the Apache License, Version 2.0 (see LICENSE.txt).
*
* Produces explicit "Zero-Clause BSD (0BSD)" title with inline license text:
*
* @license{Zero-Clause BSD (0BSD)}
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted.
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
* OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
* CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*
* @note There can't be any blank lines in the license text when using the
* simple \@license command. (See \@licenseblock below for the solution.)
*
* Produces implicit "License" title and inline, multi-paragraph license text:
*
* @licenseblock
* Licensed under the zlib/libpng License (Zlib).
*
* See the LICENSE.txt file in this distribution, or the original license text
* at https://opensource.org/licenses/Zlib.
* @endlicenseblock
*
* Produces explicit "The MIT License" title and inline, multi-paragraph text:
*
* @licenseblock{The MIT License}
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to
* deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
* IN THE SOFTWARE.
* @endlicenseblock
*/
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment