diff options
| author |  Sergio Campamá <kaipi@google.com> | 2016-08-08 07:15:02 -0700 |
|---|---|---|
| committer |  Thomas Van Lenten <thomasvl@google.com> | 2016-08-08 10:15:02 -0400 |
| commit | 32fadc0d4928c5f2d2c76fc4ddc39270673b7fa7 (patch) | |
| tree | f74e367bf821c07eda9642c2fed0b8007fec5352 /objectivec/GPBRootObject.h | |
| parent | 1102a8a7675d6b718e81b28a10173a2e073c3820 (diff) | |
Migrating documentation of the ObjectiveC runtime code to appledoc. (#1867)
Work for #1866
Migrates all the public class docs over to appledoc format. While Xcode is fine with blank lines in `///` comments, appledoc (used by cocoadocs) isn't and was leaving a bunch of info off the doc pages.
The generator still needs to be updated to do this also; that will be a follow up CL.
Diffstat (limited to 'objectivec/GPBRootObject.h')
| -rw-r--r-- | objectivec/GPBRootObject.h | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/objectivec/GPBRootObject.h b/objectivec/GPBRootObject.h index c05b5c62..d2e2aebf 100644 --- a/objectivec/GPBRootObject.h +++ b/objectivec/GPBRootObject.h @@ -34,12 +34,17 @@ NS_ASSUME_NONNULL_BEGIN -/// Every generated proto file defines a local "Root" class that exposes a -/// @c GPBExtensionRegistry for all the extensions defined by that file and -/// the files it depends on. +/** + * Every generated proto file defines a local "Root" class that exposes a + * GPBExtensionRegistry for all the extensions defined by that file and + * the files it depends on. + **/ @interface GPBRootObject : NSObject -/// An extension registry for the given file and all the files it depends on. +/** + * @return An extension registry for the given file and all the files it depends + * on. + **/ + (GPBExtensionRegistry *)extensionRegistry; @end |