Mercurial > pidgin
comparison src/proxy.h @ 6720:41120df7ed94
[gaim-migrate @ 7247]
Fixed documentation errors so Doxygen no longer complains.
committer: Tailor Script <tailor@pidgin.im>
author | Christian Hammond <chipx86@chipx86.com> |
---|---|
date | Wed, 03 Sep 2003 05:21:04 +0000 |
parents | 42fdf16f1dad |
children | fa6395637e2c |
comparison
equal
deleted
inserted
replaced
6719:3cc4d5e55a69 | 6720:41120df7ed94 |
---|---|
86 GaimProxyInfo *gaim_proxy_info_new(void); | 86 GaimProxyInfo *gaim_proxy_info_new(void); |
87 | 87 |
88 /** | 88 /** |
89 * Destroys a proxy information structure. | 89 * Destroys a proxy information structure. |
90 * | 90 * |
91 * @param proxy The proxy information structure to destroy. | 91 * @param info The proxy information structure to destroy. |
92 */ | 92 */ |
93 void gaim_proxy_info_destroy(GaimProxyInfo *info); | 93 void gaim_proxy_info_destroy(GaimProxyInfo *info); |
94 | 94 |
95 /** | 95 /** |
96 * Sets the type of proxy. | 96 * Sets the type of proxy. |
97 * | 97 * |
98 * @param proxy The proxy information. | 98 * @param info The proxy information. |
99 * @param type The proxy type. | 99 * @param type The proxy type. |
100 */ | 100 */ |
101 void gaim_proxy_info_set_type(GaimProxyInfo *info, GaimProxyType type); | 101 void gaim_proxy_info_set_type(GaimProxyInfo *info, GaimProxyType type); |
102 | 102 |
103 /** | 103 /** |
104 * Sets the proxy host. | 104 * Sets the proxy host. |
105 * | 105 * |
106 * @param proxy The proxy information. | 106 * @param info The proxy information. |
107 * @param host The host. | 107 * @param host The host. |
108 */ | 108 */ |
109 void gaim_proxy_info_set_host(GaimProxyInfo *info, const char *host); | 109 void gaim_proxy_info_set_host(GaimProxyInfo *info, const char *host); |
110 | 110 |
111 /** | 111 /** |
112 * Sets the proxy port. | 112 * Sets the proxy port. |
113 * | 113 * |
114 * @param proxy The proxy information. | 114 * @param info The proxy information. |
115 * @param port The port. | 115 * @param port The port. |
116 */ | 116 */ |
117 void gaim_proxy_info_set_port(GaimProxyInfo *info, int port); | 117 void gaim_proxy_info_set_port(GaimProxyInfo *info, int port); |
118 | 118 |
119 /** | 119 /** |
120 * Sets the proxy username. | 120 * Sets the proxy username. |
121 * | 121 * |
122 * @param proxy The proxy information. | 122 * @param info The proxy information. |
123 * @param username The username. | 123 * @param username The username. |
124 */ | 124 */ |
125 void gaim_proxy_info_set_username(GaimProxyInfo *info, const char *username); | 125 void gaim_proxy_info_set_username(GaimProxyInfo *info, const char *username); |
126 | 126 |
127 /** | 127 /** |
128 * Sets the proxy password. | 128 * Sets the proxy password. |
129 * | 129 * |
130 * @param proxy The proxy information. | 130 * @param info The proxy information. |
131 * @param password The password. | 131 * @param password The password. |
132 */ | 132 */ |
133 void gaim_proxy_info_set_password(GaimProxyInfo *info, const char *password); | 133 void gaim_proxy_info_set_password(GaimProxyInfo *info, const char *password); |
134 | 134 |
135 /** | 135 /** |
136 * Returns the proxy's type. | 136 * Returns the proxy's type. |
137 * | 137 * |
138 * @param The proxy information. | 138 * @param info The proxy information. |
139 * | 139 * |
140 * @return The type. | 140 * @return The type. |
141 */ | 141 */ |
142 GaimProxyType gaim_proxy_info_get_type(const GaimProxyInfo *info); | 142 GaimProxyType gaim_proxy_info_get_type(const GaimProxyInfo *info); |
143 | 143 |
144 /** | 144 /** |
145 * Returns the proxy's host. | 145 * Returns the proxy's host. |
146 * | 146 * |
147 * @param The proxy information. | 147 * @param info The proxy information. |
148 * | 148 * |
149 * @return The host. | 149 * @return The host. |
150 */ | 150 */ |
151 const char *gaim_proxy_info_get_host(const GaimProxyInfo *info); | 151 const char *gaim_proxy_info_get_host(const GaimProxyInfo *info); |
152 | 152 |
153 /** | 153 /** |
154 * Returns the proxy's port. | 154 * Returns the proxy's port. |
155 * | 155 * |
156 * @param The proxy information. | 156 * @param info The proxy information. |
157 * | 157 * |
158 * @return The port. | 158 * @return The port. |
159 */ | 159 */ |
160 int gaim_proxy_info_get_port(const GaimProxyInfo *info); | 160 int gaim_proxy_info_get_port(const GaimProxyInfo *info); |
161 | 161 |
162 /** | 162 /** |
163 * Returns the proxy's username. | 163 * Returns the proxy's username. |
164 * | 164 * |
165 * @param The proxy information. | 165 * @param info The proxy information. |
166 * | 166 * |
167 * @return The username. | 167 * @return The username. |
168 */ | 168 */ |
169 const char *gaim_proxy_info_get_username(const GaimProxyInfo *info); | 169 const char *gaim_proxy_info_get_username(const GaimProxyInfo *info); |
170 | 170 |
171 /** | 171 /** |
172 * Returns the proxy's password. | 172 * Returns the proxy's password. |
173 * | 173 * |
174 * @param The proxy information. | 174 * @param info The proxy information. |
175 * | 175 * |
176 * @return The password. | 176 * @return The password. |
177 */ | 177 */ |
178 const char *gaim_proxy_info_get_password(const GaimProxyInfo *info); | 178 const char *gaim_proxy_info_get_password(const GaimProxyInfo *info); |
179 | 179 |
226 /** | 226 /** |
227 * Makes a connection to the specified host and port. | 227 * Makes a connection to the specified host and port. |
228 * | 228 * |
229 * @param account The account making the connection. | 229 * @param account The account making the connection. |
230 * @param host The destination host. | 230 * @param host The destination host. |
231 * @Param port The destination port. | 231 * @param port The destination port. |
232 * @Param func The input handler function. | 232 * @param func The input handler function. |
233 * @param data User-defined data. | 233 * @param data User-defined data. |
234 * | 234 * |
235 * @return The socket handle. | 235 * @return The socket handle. |
236 */ | 236 */ |
237 int gaim_proxy_connect(GaimAccount *account, const char *host, int port, | 237 int gaim_proxy_connect(GaimAccount *account, const char *host, int port, |