We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent c511043 commit 8ec2513Copy full SHA for 8ec2513
README.md
@@ -173,6 +173,24 @@ Rules to follow for all functions:
173
* Always put a space after `,` in function signatures.
174
175
## Public Functions
176
+All public functions and methods, including those inside `object`s must have:
177
+
178
+* A return type
179
+* Scaladoc including a function overview, information on parameters, and information on the return value. See the Scaladoc section for more details.
180
181
+Here is a complete example of a function inside of an `object`.
182
183
+```scala
184
+object MyObject {
185
+ /**
186
+ * returns the static integer 123
187
+ * @return the number 123
188
+ */
189
+ def myFunction: Int = {
190
+ 123
191
+ }
192
+}
193
+```
194
195
### Parameter Lists
196
0 commit comments