Skip to content

Doxygen features/Frameworks updates to not produce warnings and errors [DOC Changes Only] #4452

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.

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

Closed
wants to merge 2 commits into from

Conversation

kegilbert
Copy link
Contributor

@kegilbert kegilbert commented Jun 5, 2017

NOTE The commit history is not cleaned up and pulls in a lot of duplicate changes from @sg-'s pull request linked below. Putting this review up to get eyes on the doxygen changes as the structure changed a decent amount for how I documented the overloaded functions. This also pulls in Jimmy's CI changes so I can get a CI run in.

Rebased to remove references to Makefile I accidentally added in my template branch.
Note to reviewers: In particular look at the following diff to see what files to review:
https://github.com/kegilbert/mbed-os/compare/kg-doxygen-template...kegilbert:kg-doxygen-framework2?expand=1


Documentation changes to Doxygen descriptions for the features/Frameworks module to allow Doxygen to build without errors/warnings.

Related PRs

#4425
#4434
#4435

Todos

  • Tests/CI
  • Review

@kegilbert
Copy link
Contributor Author

The following errors are known and being resolved in the RTOS PR (pending).

/home/travis/build/ARMmbed/mbed-os/platform/FileSystemHandle.h:44: warning: argument 'path' of command @param is not found in the argument list of FileSystemHandle::open(FileHandle **file, const char *filename, int flags)=0
/home/travis/build/ARMmbed/mbed-os/platform/FileSystemHandle.h:44: warning: The following parameters of mbed::FileSystemHandle::open(FileHandle **file, const char *filename, int flags)=0 are not documented:
parameter 'filename'
/home/travis/build/ARMmbed/mbed-os/platform/FileSystemHandle.h:33: warning: Found unknown command \Note' /home/travis/build/ARMmbed/mbed-os/platform/FileSystemHandle.h:44: warning: argument 'path' of command @param is not found in the argument list of FileSystemHandle::open(FileHandle **file, const char *filename, int flags)=0 /home/travis/build/ARMmbed/mbed-os/platform/FileSystemHandle.h:44: warning: The following parameters of mbed::FileSystemHandle::open(FileHandle **file, const char *filename, int flags)=0 are not documented: parameter 'filename' /home/travis/build/ARMmbed/mbed-os/platform/FileSystemHandle.h:33: warning: Found unknown command \Note'
/home/travis/build/ARMmbed/mbed-os/platform/FileSystemHandle.h:44: warning: argument 'path' of command @param is not found in the argument list of FileSystemHandle::open(FileHandle **file, const char *filename, int flags)=0
/home/travis/build/ARMmbed/mbed-os/platform/FileSystemHandle.h:44: warning: The following parameters of mbed::FileSystemHandle::open(FileHandle **file, const char *filename, int flags)=0 are not documented:
parameter 'filename'
/home/travis/build/ARMmbed/mbed-os/platform/FileSystemHandle.h:44: warning: argument 'path' of command @param is not found in the argument list of FileSystemHandle::open(FileHandle **file, const char *filename, int flags)=0
/home/travis/build/ARMmbed/mbed-os/platform/FileSystemHandle.h:44: warning: The following parameters of mbed::FileSystemHandle::open(FileHandle **file, const char *filename, int flags)=0 are not documented:
parameter 'filename'

@theotherjimmy
Copy link
Contributor

@kegilbert So it can't come in until that aforementioned, pending PR does.

@theotherjimmy
Copy link
Contributor

The person who's github name is param must have a bad time with doxygen output.

@kegilbert kegilbert force-pushed the kg-doxygen-framework2 branch from 1561e97 to 4fc20be Compare June 7, 2017 16:59
@kegilbert
Copy link
Contributor Author

Rebased against master following sg-'s merged doxygen-template branch (#4425) and squashed changes.

@sg-
Copy link
Contributor

sg- commented Jun 8, 2017

@kegilbert needs a rebase and should probably be consolidated into one PR at this point. The conflict will happen for each PR

@sg- sg- added the needs: work label Jun 8, 2017
@kegilbert
Copy link
Contributor Author

Good point, I'll consolidate everything to make this easier.

@kegilbert
Copy link
Contributor Author

Combined remaining doc PRs into one to avoid causing merge conflicts on each submission, follow this changeset to here: #4508

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.

4 participants