{"action":"opened","issue":{"url":"https://api.github.com/repos/sebastian-lenz/typedoc/issues/195","repository_url":"https://api.github.com/repos/sebastian-lenz/typedoc","labels_url":"https://api.github.com/repos/sebastian-lenz/typedoc/issues/195/labels{/name}","comments_url":"https://api.github.com/repos/sebastian-lenz/typedoc/issues/195/comments","events_url":"https://api.github.com/repos/sebastian-lenz/typedoc/issues/195/events","html_url":"https://github.com/sebastian-lenz/typedoc/issues/195","id":142326269,"number":195,"title":"Any way to document files externally to the source code?","user":{"login":"grofit","id":927201,"avatar_url":"https://avatars.githubusercontent.com/u/927201?v=3","gravatar_id":"","url":"https://api.github.com/users/grofit","html_url":"https://github.com/grofit","followers_url":"https://api.github.com/users/grofit/followers","following_url":"https://api.github.com/users/grofit/following{/other_user}","gists_url":"https://api.github.com/users/grofit/gists{/gist_id}","starred_url":"https://api.github.com/users/grofit/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/grofit/subscriptions","organizations_url":"https://api.github.com/users/grofit/orgs","repos_url":"https://api.github.com/users/grofit/repos","events_url":"https://api.github.com/users/grofit/events{/privacy}","received_events_url":"https://api.github.com/users/grofit/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":0,"created_at":"2016-03-21T11:56:12Z","updated_at":"2016-03-21T11:56:12Z","closed_at":null,"body":"I doubt this is supported and I doubt it would be an easy ask if it is not already but I kinda get annoyed when I have to make all my files really verbose and hard to read when there are comments everywhere. I love the actual documentation provided but ideally I keep hoping there would be a document generator tool which kinda works outside of your source code class and just kinda runs on it.\r\n\r\nSo is there any way that I can apply documentation to a file content without having to embed it within the raw `*.ts` file? just as an example I would expect something like in an ideal world:\r\n\r\n```\r\n// some-class.ts\r\nexport class SomeClass\r\n{\r\n   public something: string;\r\n}\r\n```\r\n\r\n```\r\n// some-class.doc.ts\r\n/**\r\n   #SomeClass\r\n   This class does something\r\n*/\r\n\r\n/**\r\n   #something\r\n   This variable contains a string which doesnt do much\r\n\r\n   @example\r\n   ```\r\n   someClassInstance.something = \"blah\";\r\n   ```\r\n*/\r\n```\r\n\r\nI have yet to find a documentation tool that works this way, and it baffles me why it is not supported as in a lot of cases you just want to keep your source code clean and succinct, but when you want to provide lots of nice examples, extra docs on how things can be used and how to best use certain things it starts to get pretty wordy and a simple POJO or SRP style class ends up becoming a pretty large file with all the nice docs."}}