summaryrefslogtreecommitdiff
path: root/src/lib/ecore_cocoa
diff options
context:
space:
mode:
authorMyoungwoon Roy, Kim <myoungwoon.kim@samsung.com>2017-06-07 13:01:13 +0900
committerJaehyun Cho <jae_hyun.cho@samsung.com>2017-06-07 13:01:13 +0900
commit802b547310fc5f43d825cd3cbeb898ba056a90f6 (patch)
treebdb6075a6be63b35e981dff45a3198bbd5409d5e /src/lib/ecore_cocoa
parent30b8c1ce82c91cc9624fa76d197f3c015cba438b (diff)
docs: Fix typos and some wrong expressions in Ecore, Ecore_Audio, Ecore_Cocoa, Ecore_Con, and Ector API reference doxygen.
Summary: I had fixed some typos and wrong expressions, such as capital letters, $simbols in .eo and singulars in Ecore, Ecore_Audio, Ecore_Cocoa, Ecore_Con, and Ector API reference doxygen. Test Plan: Doxygen Revision Reviewers: Jaehyun_Cho, stefan, jpeg, cedric, raster Reviewed By: Jaehyun_Cho Differential Revision: https://phab.enlightenment.org/D4943
Diffstat (limited to 'src/lib/ecore_cocoa')
-rw-r--r--src/lib/ecore_cocoa/Ecore_Cocoa.h24
1 files changed, 12 insertions, 12 deletions
diff --git a/src/lib/ecore_cocoa/Ecore_Cocoa.h b/src/lib/ecore_cocoa/Ecore_Cocoa.h
index b187f81e61..e0baf8c6d2 100644
--- a/src/lib/ecore_cocoa/Ecore_Cocoa.h
+++ b/src/lib/ecore_cocoa/Ecore_Cocoa.h
@@ -393,7 +393,7 @@ EAPI void ecore_cocoa_window_size_max_get(const Ecore_Cocoa_Window *window,
393 EINA_ARG_NONNULL(1); 393 EINA_ARG_NONNULL(1);
394 394
395/** 395/**
396 * Set a Cocoa window's resize increment 396 * Sets a Cocoa window's resize increment
397 * @param window The Cocoa window which resize increment is to be set 397 * @param window The Cocoa window which resize increment is to be set
398 * @param w The width size increment 398 * @param w The width size increment
399 * @param h The height size increment 399 * @param h The height size increment
@@ -405,7 +405,7 @@ EAPI void ecore_cocoa_window_size_step_set(Ecore_Cocoa_Window *window,
405 EINA_ARG_NONNULL(1); 405 EINA_ARG_NONNULL(1);
406 406
407/** 407/**
408 * Get a Cocoa window's resize increment 408 * Gets a Cocoa window's resize increment
409 * @param window The Cocoa window which resize increment queried 409 * @param window The Cocoa window which resize increment queried
410 * @param w The width size increment 410 * @param w The width size increment
411 * @param h The height size increment 411 * @param h The height size increment
@@ -417,7 +417,7 @@ EAPI void ecore_cocoa_window_size_step_get(const Ecore_Cocoa_Window *window,
417 EINA_ARG_NONNULL(1); 417 EINA_ARG_NONNULL(1);
418 418
419/** 419/**
420 * Display a Cocoa window 420 * Displays a Cocoa window
421 * @param window The Cocoa window to be displayed 421 * @param window The Cocoa window to be displayed
422 * @since 1.18 422 * @since 1.18
423 */ 423 */
@@ -425,7 +425,7 @@ EAPI void ecore_cocoa_window_show(Ecore_Cocoa_Window *window)
425 EINA_ARG_NONNULL(1); 425 EINA_ARG_NONNULL(1);
426 426
427/** 427/**
428 * Hide a Cocoa window 428 * Hides a Cocoa window
429 * @param window The Cocoa window to be hid 429 * @param window The Cocoa window to be hid
430 * @since 1.18 430 * @since 1.18
431 */ 431 */
@@ -467,7 +467,7 @@ EAPI void ecore_cocoa_window_title_set(Ecore_Cocoa_Window *window,
467 EINA_ARG_NONNULL(1); 467 EINA_ARG_NONNULL(1);
468 468
469/** 469/**
470 * Miniaturize or deminiaturize a Cocoa window 470 * Miniaturizes or deminiaturizes a Cocoa window
471 * @param window The Cocoa window which iconify status is to be changed 471 * @param window The Cocoa window which iconify status is to be changed
472 * @param on If #EINA_TRUE, will miniaturize the window. Will deminiaturize it if #EINA_FALSE 472 * @param on If #EINA_TRUE, will miniaturize the window. Will deminiaturize it if #EINA_FALSE
473 * @since 1.18 473 * @since 1.18
@@ -477,7 +477,7 @@ EAPI void ecore_cocoa_window_iconified_set(Ecore_Cocoa_Window *window,
477 EINA_ARG_NONNULL(1); 477 EINA_ARG_NONNULL(1);
478 478
479/** 479/**
480 * Manage the borders of a Cocoa window 480 * Manages the borders of a Cocoa window
481 * @param window The Cocoa window which borders are to be changed 481 * @param window The Cocoa window which borders are to be changed
482 * @param on If #EINA_TRUE, will remove borders. Will restore them if #EINA_FALSE 482 * @param on If #EINA_TRUE, will remove borders. Will restore them if #EINA_FALSE
483 * @since 1.18 483 * @since 1.18
@@ -487,7 +487,7 @@ EAPI void ecore_cocoa_window_borderless_set(Ecore_Cocoa_Window *window,
487 EINA_ARG_NONNULL(1); 487 EINA_ARG_NONNULL(1);
488 488
489/** 489/**
490 * Set the content view of a Cocoa window 490 * Sets the content view of a Cocoa window
491 * 491 *
492 * Refer to Apple's documentation of the property 'contentView' of 492 * Refer to Apple's documentation of the property 'contentView' of
493 * the NSWindow class for more details about the content view. 493 * the NSWindow class for more details about the content view.
@@ -502,7 +502,7 @@ EAPI void ecore_cocoa_window_view_set(Ecore_Cocoa_Window *window,
502 EINA_ARG_NONNULL(2); 502 EINA_ARG_NONNULL(2);
503 503
504/** 504/**
505 * Get the height of the title bar of Cocoa windows 505 * Gets the height of the title bar of Cocoa windows
506 * @return The height of the title bar of Cocoa windows 506 * @return The height of the title bar of Cocoa windows
507 * @since 1.18 507 * @since 1.18
508 */ 508 */
@@ -520,7 +520,7 @@ EAPI Ecore_Cocoa_Object *ecore_cocoa_window_get(const Ecore_Cocoa_Window *window
520 520
521 521
522/** 522/**
523 * Set the Cocoa cursor for a given Cocoa window 523 * Sets the Cocoa cursor for a given Cocoa window
524 * @param win The Cocoa window on which the cursor is to be changed. 524 * @param win The Cocoa window on which the cursor is to be changed.
525 * @param c The cursor to be set 525 * @param c The cursor to be set
526 * @since 1.18 526 * @since 1.18
@@ -530,7 +530,7 @@ EAPI void ecore_cocoa_window_cursor_set(Ecore_Cocoa_Window *win,
530 EINA_ARG_NONNULL(1); 530 EINA_ARG_NONNULL(1);
531 531
532/** 532/**
533 * Hide or show the Cocoa cursor for a given Cocoa window 533 * Hides or shows the Cocoa cursor for a given Cocoa window
534 * @param win The Cocoa window on which the cursor is to be hid 534 * @param win The Cocoa window on which the cursor is to be hid
535 * @param show Shows the cursor if EINA_TRUE. Hides it if EINA_FALSE 535 * @param show Shows the cursor if EINA_TRUE. Hides it if EINA_FALSE
536 * @since 1.18 536 * @since 1.18
@@ -558,7 +558,7 @@ EAPI void ecore_cocoa_terminate_cb_set(Ecore_Cocoa_Terminate_Cb cb)
558#ifdef EFL_BETA_API_SUPPORT 558#ifdef EFL_BETA_API_SUPPORT
559 559
560/* 560/*
561 * Set the clipboard of Cocoa (NSPasteboard) 561 * Sets the clipboard of Cocoa (NSPasteboard)
562 * @param data The contents to be set in the clipboard 562 * @param data The contents to be set in the clipboard
563 * @param size The size in bytes of @c data 563 * @param size The size in bytes of @c data
564 * @param type 564 * @param type
@@ -569,7 +569,7 @@ EAPI Eina_Bool ecore_cocoa_clipboard_set(const void *data,
569 Ecore_Cocoa_Cnp_Type type); 569 Ecore_Cocoa_Cnp_Type type);
570 570
571/* 571/*
572 * Get the contents of the Cocoa clipboard 572 * Gets the contents of the Cocoa clipboard
573 * @param size Pointer used to retrieve the size of the received contents 573 * @param size Pointer used to retrieve the size of the received contents
574 * @param type The type of object to retrieve from the clipboard 574 * @param type The type of object to retrieve from the clipboard
575 * @param retrieved_types The types of objects retrieved from the clipboard 575 * @param retrieved_types The types of objects retrieved from the clipboard