Skip to content

Comments

Fix up documentation errors.#3009

Merged
jeffdonahue merged 1 commit intoBVLC:masterfrom
darrengarvey:cleanup-documentation-warnings
Sep 2, 2015
Merged

Fix up documentation errors.#3009
jeffdonahue merged 1 commit intoBVLC:masterfrom
darrengarvey:cleanup-documentation-warnings

Conversation

@darrengarvey
Copy link
Contributor

Fix some doxygen warnings about an undocumented argument in Blob and
incorrect documentation in a constructor of SoftmaxWithLossLayer.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right, that documentation is correct. I was misreading it, sorry. It's actually the @copydoc SoftmaxWithLossLayer in Forward_cpu that triggers the doxygen warning.

I can update the PR with the doc for Forward_cpu removed as I don't think the same docs make sense in Forward_cpu.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, makes sense to remove the copydoc. Thanks!

@darrengarvey darrengarvey force-pushed the cleanup-documentation-warnings branch from 68d0ae4 to 19b18be Compare September 1, 2015 23:55
Fix some doxygen warnings about an undocumented argument in Blob and
incorrect documentation for SoftmaxWithLossLayer::Forward_cpu().
@darrengarvey darrengarvey force-pushed the cleanup-documentation-warnings branch from 19b18be to 6f5812c Compare September 2, 2015 00:02
jeffdonahue added a commit that referenced this pull request Sep 2, 2015
@jeffdonahue jeffdonahue merged commit e7a1dd0 into BVLC:master Sep 2, 2015
@jeffdonahue
Copy link
Contributor

Thanks @darrengarvey!

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.

2 participants