     return
 
   # Returns the YQL query
-  # str [String]
+  # @param str [String]
   self.getYQLurl = (str) ->
     q = "select * from xml where url="
     url = "'#{str}'"
     return "http://query.yahooapis.com/v1/public/yql?q=#{encodeURIComponent(q + url)}&format=json&callback=?"
 
   # Loads data for a given boardgame id
-  # id [String]
+  # @param id [String]
   self.getGameDetails = (id) ->
     if Modernizr.sessionstorage
       gdata = eval("(" + sessionStorage["bg" + id] + ")")

  # Invoked when user clicks on a table header of search results
  # Calls appropriate sort method 
  # Calls method to update icons representing sort direction
  # type [String] (name,brating)
  # vm [ViewModel]
  # event [jQueryEvent]
  self.handleSort = (type,vm,event) ->
    #default to descending sort
    #unless already sorted by the same type

    return

  # Returns the primary name of a boardgame
  # @param name [Array or String]
  self.getName = (name) ->
    return name[0].value  if Array.isArray(name)
    name.value

  # Returns shorted description of a boardgame
  # @param description [String]
  self.getShortDescription = (description) ->
    description.slice(0, 100) + "..."

  # utilities

  # Returns the html of description string
  # @param description [String]
  self.parseDescription = (description) ->
    paragraphs = 1
    contenthid = false
