Skip to content

Commit

Permalink
doc: several documentation tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
null8626 committed Jul 9, 2024
1 parent 20fe1a7 commit e1e093e
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 4 deletions.
5 changes: 4 additions & 1 deletion bindings/native/decancer.h
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
/**
* @file decancer.h
* @brief A library that removes common unicode confusables/homoglyphs from strings.
* @author Copyright (c) 2021-2024 null8626
* @author null8626
* @copyright Copyright (c) 2021-2024 null8626
* @date 2024-07-09
* @version 3.2.3
* @see https://github.com/null8626/decancer
*/

#ifndef __DECANCER_H__
Expand Down
4 changes: 2 additions & 2 deletions bindings/native/docs/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -645,13 +645,13 @@ HIDE_COMPOUND_REFERENCE= NO
# will show which file needs to be included to use the class.
# The default value is: YES.

SHOW_HEADERFILE = YES
SHOW_HEADERFILE = NO

# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
# the files that are included by a file in the documentation of that file.
# The default value is: YES.

SHOW_INCLUDE_FILES = YES
SHOW_INCLUDE_FILES = NO

# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
# grouped member an include statement to the documentation, telling the reader
Expand Down
2 changes: 1 addition & 1 deletion bindings/native/docs/docgen.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ for (const compound of index.doxygenindex.compound) {
for (const member of compound.member) {
const data = {
name: member.name,
href: member['@_refid'].replace('decancer_8h_1', 'decancer_8h.html#')
href: member['@_refid'].replace(/_1([a-f0-9]+)$/, (_, x) => `.html#${x}`)
}

switch (member['@_kind']) {
Expand Down
1 change: 1 addition & 0 deletions scripts/version.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ function updateNativeHeaderFunc(x) {
/#define DECANCER_VERSION 0x[a-fA-F0-9]{6}/,
`#define DECANCER_VERSION ${versionHex}`
)
.replace(/@date \d{4}\-\d{2}\-\d{2}/, `@date ${new Date().toISOString().replace(/T[\d\:\.]+Z$/, '')}`)
.replace(/\d\.\d\.\d/, process.argv[2])
}

Expand Down

0 comments on commit e1e093e

Please sign in to comment.