Skip to content

Add ability to include methods from independent files - #74

Merged
hacksparrow merged 1 commit into
masterfrom
fix/#57
Aug 5, 2016
Merged

hacksparrow merged 1 commit into
masterfrom
fix/#57

Conversation

@hacksparrow

Copy link
Copy Markdown
Member

The methods of a classs need not be defined in the same file as
the class file. They can be included from independent files by
adding /* @class <Name of the class> */ at the top of the
file to be included.

@hacksparrow

Copy link
Copy Markdown
Member Author

@ritch @bajtos PTAL.

@bajtos

bajtos commented Jul 12, 2016

Copy link
Copy Markdown
Member

To be honest, this code looks like pure magic to me and I don't have time right now to build deep understanding of how it actually works. I don't see any obvious problems, and considering that @ritch hasn't responded in the last two weeks, I think it's ok to land this patch as it is.

@hacksparrow I have one question only, the comment for assigning a file to a class, should it start with /* or /**? My impression was that we are processing only jsdoc comments, i.e. /** and ///. The pull request description says /* @class <Name of the class> */. What is correct?

@hacksparrow

Copy link
Copy Markdown
Member Author

Both /* and /** are valid. The parsing is done by dox. So as long as dox can parse, it works.

@hacksparrow

Copy link
Copy Markdown
Member Author

@rmg any idea why those two are failing?

@rmg

rmg commented Jul 13, 2016

Copy link
Copy Markdown
Member

The downstream failure appears to be the old job for deploying the apidocs site. I'll take a closer look later.

@bajtos

bajtos commented Jul 14, 2016

Copy link
Copy Markdown
Member

@hacksparrow fair enough. :shipit:

@hacksparrow

Copy link
Copy Markdown
Member Author

@rmg yo!

@rmg

rmg commented Jul 27, 2016

Copy link
Copy Markdown
Member

@hacksparrow I've removed the dependency trigger, but you'll need to rebase in order to clear the failure status for the PR since statuses are set directly on the commits.

@hacksparrow

Copy link
Copy Markdown
Member Author

@rmg still the same.

@rmg

rmg commented Aug 1, 2016

Copy link
Copy Markdown
Member

@hacksparrow I had to dig a little deeper than expected, but it should be fixed now. You can either rebase to clear the status or you can just ignore the failure.

The methods of a classs need not be defined in the same file as
the class file. They can be included from independent files by
adding `/* @Class <Name of the class> */` at the top of the
file to be included.
@hacksparrow
hacksparrow merged commit fd697e9 into master Aug 5, 2016
@hacksparrow hacksparrow mentioned this pull request Sep 13, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants