Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Javadoc? #70

Open
davisjam opened this issue Sep 27, 2017 · 1 comment
Open

Javadoc? #70

davisjam opened this issue Sep 27, 2017 · 1 comment

Comments

@davisjam
Copy link
Contributor

Should this project have Javadoc e.g. to describe the classes and their methods?

For example, I was surprised to see that the PersistenceMechanism(s) given to RepositoryMining.process will be auto-closed, and could only find this out from the source.
@davisjam davisjam mentioned this issue Sep 27, 2017
Merged
@mauricioaniche
Copy link
Owner

Yes, definitely! Feel free to add any documentation. I'll make sure to write them whenever I have some change to do.

@davisjam davisjam mentioned this issue Sep 28, 2017
Merged
davisjam added a commit to davisjam/repodriller that referenced this issue Oct 5, 2017
@davisjam
Some Javadoc. Towards mauricioaniche#70.
0ec563d
davisjam added a commit to davisjam/repodriller that referenced this issue Oct 5, 2017
@davisjam
Some Javadoc. Towards mauricioaniche#70.
1d54e56
mauricioaniche pushed a commit that referenced this issue Oct 10, 2017
@davisjam @mauricioaniche
Some Javadoc. Towards #70. (#81)
d8621f5 
* Some Javadoc. Towards #70.

* Javadoc for FileUtils
mauricioaniche pushed a commit that referenced this issue Oct 13, 2017
@davisjam @mauricioaniche
GitRepository refactoring (#82)
c4f752e 
* Use a consistent approach to get system properties

Reduce duplicate code with a helper function.

* Some Javadoc. Towards #70.

* Simplify GitRepository.getCommit

Problem:
git.log will give us all of the commits beginning at the specified commit.
getCommit was iterating over all such commits but returning after the first one.
This was unnecessarily complex.

Solution:
Replace this idiom with "retrieve the first JGitCommit and process it".

Bonus material:
 - Misc. TODOs
 - Add a new Commit.addModification to be more Java-like

* Synchronize GitRepository.files

Since files() walks the directory tree, it can race with checkout and reset.

* Misc edits

* Remove deprecated addModification method

* Address comments from @mauricioaniche

* Fix build error
@davisjam davisjam mentioned this issue Oct 13, 2017
Merged
davisjam added a commit to davisjam/repodriller that referenced this issue Oct 17, 2017
@davisjam
Javadoc
dc2f2ef 
Towards mauricioaniche#70
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mauricioaniche @davisjam