Add JSDoc documentation and file headers to all source files
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
@@ -1,8 +1,21 @@
|
||||
// The Lucia project.
|
||||
// Copyright 2023-2026 DSP, inc. All rights reserved.
|
||||
// Authors:
|
||||
// chiayin.kuo@dsp.im (chiayin), 2023/1/31
|
||||
// imacat.yang@dsp.im (imacat), 2023/9/23
|
||||
// cindy.chang@dsp.im (Cindy Chang), 2024/5/30
|
||||
/** @module pageUtils Page name mapping utilities. */
|
||||
|
||||
/**
|
||||
* Convert or map raw page name to an upper case string
|
||||
* and possibly change the name to another name
|
||||
* @param {string} rawPageName
|
||||
* @returns {string}
|
||||
* Maps a raw route page name to a unified uppercase display name.
|
||||
*
|
||||
* Converts "Check"-prefixed route names (e.g. "CheckMap") to their
|
||||
* base names (e.g. "MAP"), and "CompareDashboard" to "DASHBOARD".
|
||||
* All other names are simply uppercased.
|
||||
*
|
||||
* @param {string} rawPageName - The raw route name to convert.
|
||||
* @returns {string|undefined} The unified uppercase name, or
|
||||
* undefined if rawPageName is falsy.
|
||||
*/
|
||||
const mapPageNameToCapitalUnifiedName = (rawPageName) => {
|
||||
if(rawPageName) {
|
||||
@@ -19,9 +32,9 @@ const mapPageNameToCapitalUnifiedName = (rawPageName) => {
|
||||
return rawPageName.toUpperCase();
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
};
|
||||
|
||||
export {
|
||||
mapPageNameToCapitalUnifiedName,
|
||||
};
|
||||
};
|
||||
|
||||
Reference in New Issue
Block a user