Add API comments for dropdown menu directive

T-91

Add API comments for dropdown menu directive
T-91
7a0bca59 · Robert Knight · Nick Stenning · f0aaf620 · 7a0bca59
Commit 7a0bca59 authored Oct 20, 2015 by Robert Knight Committed by Nick Stenning Oct 21, 2015
Show whitespace changes
Inline Side-by-side

Showing with 6 additions and 0 deletions

sort-dropdown.js h/static/scripts/directive/sort-dropdown.js +6 -0

No files found.
--- a/h/static/scripts/directive/sort-dropdown.js
+++ b/h/static/scripts/directive/sort-dropdown.js
@@ -2,9 +2,15 @@ module.exports = function () {
  return {
    restrict: 'E',
    scope: {
+      /** The name of the currently selected sort criteria. */
      sortBy: '=',
+      /** A list of choices that the user can opt to sort by. */
      sortOptions: '=',
+      /** If true, the menu uses just an icon, otherwise
+       * it displays 'Sorted by {{sortBy}}'
+       */
      showAsIcon: '=',
+      /** Called when the user changes the current sort criteria. */
      onChangeSortBy: '&',
    },
    templateUrl: 'sort_dropdown.html',