mirror of
https://github.com/profanity-im/profanity.git
synced 2024-10-27 20:30:13 -04:00
Fix typos in apidocs
This commit is contained in:
parent
9696f4d5cc
commit
d64e797665
@ -127,7 +127,7 @@ Retrieve the Jabber ID of the current room, when in a chat room window.
|
|||||||
char* prof_get_current_muc(void);
|
char* prof_get_current_muc(void);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Determine whether or not the Console window is currently focussed.
|
Determine whether or not the Console window is currently focused.
|
||||||
@return 1 if the user is currently in the Console window, 0 otherwise.
|
@return 1 if the user is currently in the Console window, 0 otherwise.
|
||||||
*/
|
*/
|
||||||
int prof_current_win_is_console(void);
|
int prof_current_win_is_console(void);
|
||||||
|
@ -208,13 +208,13 @@ Called when a presence notification is received from a contact
|
|||||||
void prof_on_contact_presence(const char *const barejid, const char *const resource, const char *const presence, const char *const status, const int priority);
|
void prof_on_contact_presence(const char *const barejid, const char *const resource, const char *const presence, const char *const status, const int priority);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Called when a chat window is focussed
|
Called when a chat window is focused
|
||||||
@param barejid Jabber ID of the chat window recipient
|
@param barejid Jabber ID of the chat window recipient
|
||||||
*/
|
*/
|
||||||
void prof_on_chat_win_focus(const char *const barejid);
|
void prof_on_chat_win_focus(const char *const barejid);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Called when a chat room window is focussed
|
Called when a chat room window is focused
|
||||||
@param barejid Jabber ID of the room
|
@param barejid Jabber ID of the room
|
||||||
*/
|
*/
|
||||||
void prof_on_room_win_focus(const char *const barejid);
|
void prof_on_room_win_focus(const char *const barejid);
|
||||||
|
@ -343,7 +343,7 @@ def prof_on_contact_presence(barejid, resource, presence, status, priority):
|
|||||||
|
|
||||||
|
|
||||||
def prof_on_chat_win_focus(barejid):
|
def prof_on_chat_win_focus(barejid):
|
||||||
"""Called when a chat window is focussed
|
"""Called when a chat window is focused
|
||||||
|
|
||||||
:param barejid: Jabber ID of the chat window recipient
|
:param barejid: Jabber ID of the chat window recipient
|
||||||
:type barejid: str or unicode
|
:type barejid: str or unicode
|
||||||
@ -352,7 +352,7 @@ def prof_on_chat_win_focus(barejid):
|
|||||||
|
|
||||||
|
|
||||||
def prof_on_room_win_focus(barejid):
|
def prof_on_room_win_focus(barejid):
|
||||||
"""Called when a chat room window is focussed
|
"""Called when a chat room window is focused
|
||||||
|
|
||||||
:param barejid: Jabber ID of the room
|
:param barejid: Jabber ID of the room
|
||||||
:type barejid: str or unicode
|
:type barejid: str or unicode
|
||||||
|
@ -290,7 +290,7 @@ def get_room_nick(barejid):
|
|||||||
|
|
||||||
|
|
||||||
def current_win_is_console():
|
def current_win_is_console():
|
||||||
"""Determine whether or not the Console window is currently focussed.
|
"""Determine whether or not the Console window is currently focused.
|
||||||
|
|
||||||
:return: ``True`` if the user is currently in the Console window, ``False`` otherwise.
|
:return: ``True`` if the user is currently in the Console window, ``False`` otherwise.
|
||||||
:rtype: boolean
|
:rtype: boolean
|
||||||
|
Loading…
Reference in New Issue
Block a user