Codechange: Unify naming of squirrel built-in types in Script API docs

This commit is contained in:
frosch
2024-03-24 19:02:16 +01:00
committed by Peter Nelson
parent e436e2ef40
commit dfa2622153
6 changed files with 21 additions and 11 deletions

View File

@@ -42,21 +42,21 @@ public:
* @param priority The priority to assign the item.
* @return True if the item was inserted, false if it was already in the queue.
*/
bool Insert(void *item, SQInteger priority);
bool Insert(object item, SQInteger priority);
/**
* Remove and return the item with the lowest priority.
* @return The item with the lowest priority, removed from the queue. Returns null on an empty queue.
* @pre !IsEmpty()
*/
void *Pop();
object Pop();
/**
* Get the item with the lowest priority, keeping it in the queue.
* @return The item with the lowest priority. Returns null on an empty queue.
* @pre !IsEmpty()
*/
void *Peek();
object Peek();
/**
* Check if an items is already included in the queue.
@@ -64,7 +64,7 @@ public:
* @return true if the items is already in the queue.
* @note Performance is O(n), use only when absolutely required.
*/
bool Exists(void *item);
bool Exists(object item);
/**
* Clear the queue, making Count() returning 0 and IsEmpty() returning true.