Skip to content

chore: Modernize jsdoc format #2205

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
marcustyphoon wants to merge 2 commits into
base: master
Choose a base branch
from
Open

chore: Modernize jsdoc format #2205

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7b20896
modernize jsdoc
marcustyphoon Apr 1, 2026
2f91849
enough to make it pass current ci.
marcustyphoon Apr 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions Extensions/one_click_postage.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,11 +393,11 @@ XKit.extensions.one_click_postage = new Object({

/**
* If auto_tagger is enabled use it to get tags. Otherwise return ""
* @param {Object} post - Post object, like those returned by
* @param {object} post - Post object, like those returned by
* XKit.interface.post and XKit.interface.find_post
* @param {number} state - Post state: 0 is reblog, 1 is draft, 2 is queue
* @param {Boolean} isOriginal
* @return {String} tags
* @param {boolean} isOriginal
* @returns {string} tags
*/
get_auto_tagger_tags: function(post, state, isOriginal) {
if (!this.auto_tagger) {
Expand All @@ -419,9 +419,9 @@ XKit.extensions.one_click_postage = new Object({
/**
* Return the addition of tags based on state from the auto_tagger. Only
* queue is handled by this function because state is a horrible variable
* @param {String} tags - current tags
* @param {string} tags - current tags
* @param {number} state - Post state: 0 is reblog, 1 is draft, 2 is queue
* @return {String} new tags
* @returns {string} new tags
*/
add_auto_tagger_state_tags: function(tags, state) {
if (!this.auto_tagger) {
Expand Down Expand Up @@ -875,7 +875,7 @@ XKit.extensions.one_click_postage = new Object({

/**
* @param {Event} e
* @return {boolean} Whether e corresponds to an OCP key command
* @returns {boolean} Whether e corresponds to an OCP key command
*/
is_key_command: function(e) {
if (e.metaKey || e.altKey || e.ctrlKey || e.shiftKey) {
Expand Down
10 changes: 5 additions & 5 deletions Extensions/one_click_reply.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,11 +169,11 @@ XKit.extensions.one_click_reply = new Object({
},
/**
* Creates blog post
* @param {String} sentence - html content
* @param {String} tags - comma-separated tags
* @param {Object} reply - A "reply" to append to the sentence
* @param {String} blog - the id of the blog to post as
* @param {Boolean?} retry_mode - If false, allows one retry
* @param {string} sentence - html content
* @param {string} tags - comma-separated tags
* @param {object} reply - A "reply" to append to the sentence
* @param {string} blog - the id of the blog to post as
* @param {boolean?} retry_mode - If false, allows one retry
*/
quick_reply_post: function(sentence, tags, reply, blog, retry_mode) {
var m_object = {};
Expand Down
Loading
Loading