Correct the @var, @throws and @see statements on dbtng [#2064261]

Problem/Motivation

#2057809: Correct the @param and @return statements on dbtng has been committed and only @param and @return statements were included, to limit patch size.
This issue will focus on @var, @see and @throws statements, as I already worked on them in the previous one.

#2057809: Correct the @param and @return statements on dbtng

Patch is coming.

Comment	File	Size	Author
#1	var_see_throws-2064261-1.patch	20.71 KB	StephaneQ
#1

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

StephaneQ

French

Paris 🇫🇷

CreditAttribution: StephaneQ commented 13 August 2013 at 15:40

Status:

Active

» Needs review

File	Size
var_see_throws-2064261-1.patch	20.71 KB

Comment #2

dawehner

German

CreditAttribution: dawehner commented 13 August 2013 at 18:29

Status:

Needs review

» Reviewed & tested by the community

@@ -981,10 +981,10 @@ public function pushTransaction($name) {
+   * @throws \Drupal\Core\Database\TransactionNoActiveException
+   * @throws \Drupal\Core\Database\TransactionCommitFailedException

In general I kinda like if something describes why a certain exception is thrown , but that is maybe out of scope... but I don't block this issue upon that.

Comment #3

Dries CreditAttribution: Dries commented 13 August 2013 at 18:41

Status:

Reviewed & tested by the community

» Fixed

Committed to 8.x. Thanks.

Comment #4

jhodgdon

she/her

English

CreditAttribution: jhodgdon commented 13 August 2013 at 19:12

@dawehner - regarding @throws, the current standard is that if the exception class name doesn't tell everything we would need to know, then there should be explanations starting on the next line.

In most/all of the cases in this patch, I think the class names are pretty much self-explanatory, but definitely if you think more information is needed, that can be added.