Menu

Can doxygen auto-update the \copyright text?

2017-05-18
2020-10-16
  • Ed Jubenville

    Ed Jubenville - 2017-05-18

    I'd like use an alias to define my company's copyright, e.g., "ALIASES = my_copyright="\copyright blah blah blah". I want to ensure that all copyright notices are consistent, and can all be changed in one fell swoop by editing the alias. We recently went through a company name change, and all copyright notices were affected.

    If I use a copyright alias, my source files would only contain "/// \my_copyright", not the actual copyright. How do other doxygen users solve this problem?

    A tool that behaves somewhat like CVS/SVN keyword substitution could do the job. Those tools uses a delimiter syntax and can modify the source files. For example, "$Log: log data here $" would replace the old log data with the latest log data in. Can anything like that be done with doxygen? I know that doxygen is generally read-only with respect to source files, but maybe there is a way?

     
  • Marco Sillano

    Marco Sillano - 2019-01-19

    This can be done easy with a custom filter (see post Filters4Doxygen)

    Using regexfilter.java you must build a file '.RGX' that contains the macro-replacements: e.g.

    regex1=$my_copyright$
    replacement1=\\copyright blah blah blah
    

    You must also create a BAT (or sh) driver: see as example bat2dox.rgx
    Associate you driver to all file you like update (C, C++, Java etc.)
    This filter don't change line number so it is safe also with source pages.

    I hope that can help
    Best regard
    m.s.

     
  • Job Search

    Job Search - 2020-10-16

    Searching for a Job difficult for everyone but we have few steps where we have help others for making the job search very easy for everyone. And here is the step.
    step 1 make your mind which job you want to do
    step 2 go to on job searching websites like kaam24
    step 3 search a job which you want to apply get the healthy discussion with them and those little steps make your job search journey easy

     
  • hiflyjobs

    hiflyjobs - 2021-11-18
    Post awaiting moderation.

Log in to post a comment.

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.