Skip to content
This repository has been archived by the owner on Dec 15, 2022. It is now read-only.

Issue parsing 'Returns' in description #13

Closed
UziTech opened this issue Jul 26, 2017 · 1 comment
Closed

Issue parsing 'Returns' in description #13

UziTech opened this issue Jul 26, 2017 · 1 comment
Labels

Comments

@UziTech
Copy link

UziTech commented Jul 26, 2017

Moved from atom/atom#15101

The Atom Workspace documentation lists a workspace item's required methods but does not list the optional methods listed in the comments of /src/workspace.js.

image

Once the parser hits the Returns keyword after getTitle() it thinks the description is over.

@UziTech
Copy link
Author

UziTech commented Jun 24, 2019

this is still an issue. The documentation doesn't show any methods for the "item" interface other than getTitle() (with no description)

The docs should show descriptions for:

  • getElement()
  • destroy()
  • onDidDestroy(callback)
  • serialize()
  • getURI()
  • getLongTitle()
  • onDidChangeTitle(callback)
  • getIconName()
  • onDidChangeIcon(callback)
  • getDefaultLocation()
  • getAllowedLocations()
  • isPermanentDockItem()
  • save()
  • saveAs(path)
  • getPath()
  • isModified()
  • onDidChangeModified()
  • copy()
  • getPreferredHeight()
  • getPreferredWidth()
  • onDidTerminatePendingState(callback)
  • shouldPromptToSave()

from the Workspace Comments

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

2 participants