Skip to content

Commit

Permalink
Merge pull request naver#43 from sculove/fixdoc#9
Browse files Browse the repository at this point in the history
Fixdoc#9
  • Loading branch information
sculove committed Dec 24, 2015
2 parents 8a8aa3c + 213c80b commit d6358ec
Show file tree
Hide file tree
Showing 11 changed files with 112 additions and 65 deletions.
2 changes: 1 addition & 1 deletion src/class.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ eg.module("class", [eg], function(ns) {
* @class
* @name eg.Class
*
* @support {"ie": "7+", "ch" : "latest", "ff" : "latest", "sf" : "latest", "ios" : "7+", "an" : "2.1+ (except 3.x)", "n-ios" : "latest", "n-an" : "latest" }
* @support {"ie": "7+", "ch" : "latest", "ff" : "latest", "sf" : "latest", "ios" : "7+", "an" : "2.1+ (except 3.x)"}
* @param {Object} def Class definition of object literal type. <ko>리터럴 형태의 클래스 정의부</ko>
* @example
var Some = eg.Class({
Expand Down
2 changes: 1 addition & 1 deletion src/component.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ eg.module("component", [eg], function(ns) {
* @group egjs
* @name eg.Component
*
* @support {"ie": "7+", "ch" : "latest", "ff" : "latest", "sf" : "latest", "ios" : "7+", "an" : "2.1+ (except 3.x)", "n-ios" : "latest", "n-an" : "latest" }
* @support {"ie": "7+", "ch" : "latest", "ff" : "latest", "sf" : "latest", "ios" : "7+", "an" : "2.1+ (except 3.x)"}
*/
ns.Component = ns.Class({
construct: function() {
Expand Down
2 changes: 1 addition & 1 deletion src/customEvent/rotate.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ eg.module("rotate", ["jQuery", eg, window, document], function($, ns, global, do
* @event
* @param {Event} e event
* @param {Boolean} e.isVertical vertical <ko>수직여부</ko>
* @support { "ios" : "7+", "an" : "2.1+ (except 3.x)", "n-ios" : "latest", "n-an" : "latest" }
* @support { "ios" : "7+", "an" : "2.1+ (except 3.x)"}
* @example
* $(window).on("rotate",function(e){
* e.isVertical;
Expand Down
2 changes: 1 addition & 1 deletion src/customEvent/scrollEnd.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ eg.module("scrollEnd", ["jQuery", eg, window], function($, ns, global) {
* @event
* @param {Number} e.top top position <ko>상단(top) 위치 값</ko>
* @param {Number} e.left left position <ko>왼쪽(left) 위치 값</ko>
* @support {"ie": "9+", "ch" : "latest", "ff" : "latest", "sf" : "latest", "ios" : "7+", "an" : "2.1+ (except 3.x)", "n-ios" : "latest", "n-an" : "latest" }
* @support {"ie": "9+", "ch" : "latest", "ff" : "latest", "sf" : "latest", "ios" : "7+", "an" : "2.1+ (except 3.x)"}
* @example
* $(window).on("scrollend",function(e){
* e.top;
Expand Down
131 changes: 91 additions & 40 deletions src/flicking.js
Original file line number Diff line number Diff line change
Expand Up @@ -54,44 +54,6 @@ eg.module("flicking", ["jQuery", eg, window, document, eg.MovableCoord], functio
);
</script>
*/
/**
* Flicking plugin in jQuery
*
* @ko jQuery flicking plugin
* @name jQuery#flicking
* @event
* @example
<!-- HTML -->
<div id="mflick">
<div>
<p>Layer 0</p>
</div>
<div>
<p>Layer 1</p>
</div>
<div>
<p>Layer 2</p>
</div>
</div>
<script>
// create
$("#mflick").flicking({
circular : true,
threshold : 50
});
// event
$("#mflick").on("flicking:beforeRestore",callback);
$("#mflick").off("flicking:beforeRestore",callback);
$("#mflick").trigger("flicking:beforeRestore",callback);
// method
$("#mflick").flicking("option","circular",true); //Set option
$("#mflick").flicking("instance"); // Return flicking instance
$("#mflick").flicking("getNextIndex",1); // Get next panel index
</script>
* @see eg.Flicking
*/

// define custom events name
var EVENTS = {
Expand Down Expand Up @@ -581,7 +543,6 @@ eg.module("flicking", ["jQuery", eg, window, document, eg.MovableCoord], functio
* @ko 패널이 이동될 때 발생하는 이벤트
* @name eg.Flicking#flick
* @event
*
* @param {Object} param
* @param {String} param.eventType Name of event <ko>이벤트명</ko>
* @param {Number} param.index Current panel physical index <ko>현재 패널 물리적 인덱스</ko>
Expand Down Expand Up @@ -1212,4 +1173,94 @@ eg.module("flicking", ["jQuery", eg, window, document, eg.MovableCoord], functio
return this;
}
});
});
});
/**
* Flicking in jQuery plugin
*
* @ko Flicking in jQuery plugin
* @method jQuery.flicking
* @example
<div id="content">
<div>
<p>Layer 0</p>
</div>
<div>
<p>Layer 1</p>
</div>
<div>
<p>Layer 2</p>
</div>
</div>
<script>
// create
$("#content").flicking({
circular : true,
threshold : 50
});
// method
$("#content").flicking("option","circular",true); //Set option
$("#content").flicking("instance"); // Return flicking instance
$("#content").flicking("getNextIndex",1); // Get next panel index
</script>
* @see eg.Flicking
*/
/**
* flicking:beforeRestore jQuery event plugin
*
* @ko flicking:beforeRestore jQuery event plugin
* @name jQuery#flicking:beforeRestore
* @event
* @example
$("#mflick").on("flicking:beforeRestore",callback);
$("#mflick").off("flicking:beforeRestore",callback);
$("#mflick").trigger("flicking:beforeRestore",callback);
* @see eg.Flicking#event:beforeRestore
*/
/**
* flicking:beforeFlickStart jQuery event plugin
*
* @ko flicking:beforeFlickStart jQuery event plugin
* @name jQuery#flicking:beforeFlickStart
* @event
* @example
$("#mflick").on("flicking:beforeFlickStart",callback);
$("#mflick").off("flicking:beforeFlickStart",callback);
$("#mflick").trigger("flicking:beforeFlickStart",callback);
* @see eg.Flicking#event:beforeFlickStart
*/
/**
* flicking:flick jQuery event plugin
*
* @ko flicking:flick jQuery event plugin
* @name jQuery#flicking:flick
* @event
* @example
$("#mflick").on("flicking:flick",callback);
$("#mflick").off("flicking:flick",callback);
$("#mflick").trigger("flicking:flick",callback);
* @see eg.Flicking#event:flick
*/
/**
* flicking:flickEnd jQuery event plugin
*
* @ko flicking:flickEnd jQuery event plugin
* @name jQuery#flicking:flickEnd
* @event
* @example
$("#mflick").on("flicking:flickEnd",callback);
$("#mflick").off("flicking:flickEnd",callback);
$("#mflick").trigger("flicking:flickEnd",callback);
* @see eg.Flicking#event:flickEnd
*/
/**
* flicking:restore jQuery event plugin
*
* @ko flicking:restore jQuery event plugin
* @name jQuery#flicking:restore
* @event
* @example
$("#mflick").on("flicking:restore",callback);
$("#mflick").off("flicking:restore",callback);
$("#mflick").trigger("flicking:restore",callback);
* @see eg.Flicking#event:restore
*/
2 changes: 1 addition & 1 deletion src/hook/animate.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ eg.module("animate", ["jQuery", window], function($, global) {
* .animate({"transform" : "+=translate3d(150px, 10%, -20px) rotate(20deg) scale3d(2, 4.2, 1)"} , 3000);
* @see {@link http://api.jquery.com/animate/}
*
* @support {"ie": "10+", "ch" : "latest", "sf" : "latest", "ios" : "7+", "an" : "2.3+ (except 3.x)", "n-ios" : "latest", "n-an" : "latest" }
* @support {"ie": "10+", "ch" : "latest", "sf" : "latest", "ios" : "7+", "an" : "2.3+ (except 3.x)"}
*/
var supportFloat32Array = "Float32Array" in window;
var CSSMatrix = global.WebKitCSSMatrix || global.MSCSSMatrix ||
Expand Down
2 changes: 1 addition & 1 deletion src/hook/css.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ eg.module("css", ["jQuery", document], function($, doc) {
* @name jQuery#css
* @method
*
* * @support {"ie": "10+", "ch" : "latest", "ff" : "latest", "sf" : "latest", "ios" : "7+", "an" : "2.1+ (except 3.x)", "n-ios" : "latest", "n-an" : "latest" }
* * @support {"ie": "10+", "ch" : "latest", "ff" : "latest", "sf" : "latest", "ios" : "7+", "an" : "2.1+ (except 3.x)"}
* @example
* $("#ID").css("transform", "translate('10px', '10px');
* $("#ID").css("Transform", "translate('10px', '10px');
Expand Down
24 changes: 10 additions & 14 deletions src/infiniteGrid.js
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ eg.module("infiniteGrid", ["jQuery", eg, window, "Outlayer"], function($, ns, gl
* @param {Number} [options.count=30] when count value is greater than 0, grid will maintain same DOM length recycling <ko>count값이 0보다 클 경우, 그리드는 일정한 dom 개수를 유지한다</ko>
*
* @codepen {"id":"zvrbap", "ko":"InfiniteGrid 데모", "en":"InfiniteGrid example", "collectionId":"DPYEww", "height": 403}
* @support {"ie": "8+", "ch" : "latest", "ff" : "latest", "sf" : "latest", "ios" : "7+", "an" : "2.1+ (except 3.x)", "n-ios" : "latest", "n-an" : "latest" }
* @support {"ie": "8+", "ch" : "latest", "ff" : "latest", "sf" : "latest", "ios" : "7+", "an" : "2.1+ (except 3.x)"}
*
* @see Outlayer {@link https://github.com/metafizzy/outlayer}
*
Expand Down Expand Up @@ -716,13 +716,13 @@ eg.module("infiniteGrid", ["jQuery", eg, window, "Outlayer"], function($, ns, gl
</ul>
<script>
// create
$("#content").infiniteGrid({
$("#grid").infiniteGrid({
itemSelector : ".item"
});
// method
$("#content").infiniteGrid("option","itemSelector",".selected"); //Set option
$("#content").infiniteGrid("instance"); // Return infiniteGrid instance
$("#content").infiniteGrid("getBottomElement"); // Get bottom element
$("#grid").infiniteGrid("option","itemSelector",".selected"); //Set option
$("#grid").infiniteGrid("instance"); // Return infiniteGrid instance
$("#grid").infiniteGrid("getBottomElement"); // Get bottom element
</script>
* @see eg.InfiniteGrid
*/
Expand All @@ -732,10 +732,6 @@ eg.module("infiniteGrid", ["jQuery", eg, window, "Outlayer"], function($, ns, gl
* @ko infiniteGrid:layoutComplete jQuery event plugin
* @name jQuery#infiniteGrid:layoutComplete
* @event
* @param {Object} param
* @param {Array} param.target target rearranged elements<ko>재배치된 엘리먼트들</ko>
* @param {Boolean} param.isAppend isAppend determine if append or prepend (value is true when call layout method)<ko>아이템이 append로 추가되었는지, prepend로 추가되었는지를 반한환다. (layout호출시에는 true)</ko>
* @param {Number} param.distance distance<ko>layout 전의 최상단 엘리먼트의 거리</ko>
* @example
<ul id="grid">
<li class="item">
Expand All @@ -747,13 +743,13 @@ eg.module("infiniteGrid", ["jQuery", eg, window, "Outlayer"], function($, ns, gl
</ul>
<script>
// create
$("#content").infiniteGrid({
$("#grid").infiniteGrid({
itemSelector : ".item"
});
// event
$("#content").on("infiniteGrid:layoutComplete",callback);
$("#content").off("infiniteGrid:layoutComplete",callback);
$("#content").trigger("infiniteGrid:layoutComplete",callback);
$("#grid").on("infiniteGrid:layoutComplete",callback);
$("#grid").off("infiniteGrid:layoutComplete",callback);
$("#grid").trigger("infiniteGrid:layoutComplete",callback);
</script>
* @see eg.InfiniteGrid
* @see eg.InfiniteGrid#event:layoutComplete
*/
2 changes: 1 addition & 1 deletion src/movableCoord.js
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ eg.module("movableCoord", ["jQuery", eg, "Hammer"], function($, ns, HM) {
* @see Easing Functions Cheat Sheet {@link http://easings.net/}
* @see To use other easing functions, import jQuery easing plugin({@link http://gsgd.co.uk/sandbox/jquery/easing/}) or jQuery UI easing.({@link https://jqueryui.com/easing/})<ko>다른 easing 함수를 사용하고 싶다면, jQuery easing plugin({@link http://gsgd.co.uk/sandbox/jquery/easing/})이나, jQuery UI easing({@link https://jqueryui.com/easing/}) 라이브러리를 삽입해야 한다.</ko>
*
* @support {"ie": "10+", "ch" : "latest", "ff" : "latest", "sf" : "latest", "ios" : "7+", "an" : "2.3+ (except 3.x)", "n-ios" : "latest", "n-an" : "latest" }
* @support {"ie": "10+", "ch" : "latest", "ff" : "latest", "sf" : "latest", "ios" : "7+", "an" : "2.3+ (except 3.x)"}
*/
var MC = ns.MovableCoord = ns.Class.extend(ns.Component, {
construct: function(options) {
Expand Down
2 changes: 1 addition & 1 deletion src/plugin/persist.js
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ eg.module("persist", ["jQuery", eg, window, document], function($, ns, global, d
* Save current state
* @ko 인자로 넘긴 현재 상태정보를 저장한다.
* @method jQuery.persist
* @support {"ie": "9+", "ch" : "latest", "ff" : "1.5+", "sf" : "latest", "ios" : "7+", "an" : "2.2+ (except 3.x)", "n-ios" : "latest", "n-an" : "latest" }
* @support {"ie": "9+", "ch" : "latest", "ff" : "1.5+", "sf" : "latest", "ios" : "7+", "an" : "2.2+ (except 3.x)"}
* @param {Object} state State object to be stored in order to restore UI component's state <ko>UI 컴포넌트의 상태를 복원하기위해 저장하려는 상태 객체</ko>
* @example
$("a").on("click",function(e){
Expand Down
6 changes: 3 additions & 3 deletions src/visible.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ eg.module("visible", ["jQuery", eg, document], function($, ns, doc) {
* @extends eg.Component
* @group egjs
*
* @param {HTMLElement|String|jQuery} [element=document] The parent element that to check targets (wrapper is only one.) <ko>확인할 영역의 상위 엘리먼트</ko>
* @param {Object} options
* @param {HTMLElement|String|jQuery} [options.wrapper=document] The parent element that to check targets (wrapper is only one.) <ko>확인할 영역의 상위 엘리먼트</ko>
* @param {String} [options.targetClass="check_visible"] A class name of targets <ko>확인할 엘리먼트가 가진 클래스명</ko>
* @param {Number} [options.expandSize=0] expand size of the wrapper.
* e.g. If a wrapper size is 100 x 100 and 'expandSize' option is 20, visible range is 120 x 120
* <ko> 상위 엘리먼트 기준으로 추가적인 영역을 확인하도록 지정</ko>
* @support {"ie": "7+", "ch" : "latest", "ff" : "latest", "sf" : "latest", "ios" : "7+", "an" : "2.1+ (except 3.x)", "n-ios" : "latest", "n-an" : "latest" }
* @support {"ie": "7+", "ch" : "latest", "ff" : "latest", "sf" : "latest", "ios" : "7+", "an" : "2.1+ (except 3.x)"}
*
* @codepen {"id":"WbWzqq", "ko":"Visible 기본 예제", "en":"Visible basic example", "collectionId":"Ayrabj", "height" : 403}
*/
Expand Down Expand Up @@ -222,5 +222,5 @@ eg.module("visible", ["jQuery", eg, document], function($, ns, doc) {
$("body").visible("option","circular",true); //Set option
$("body").visible("instance"); // Return flicking instance
$("body").visible("check",10); // Check to change target elements.
* @see eg.Visble
* @see eg.Visble#event:change
*/

0 comments on commit d6358ec

Please sign in to comment.