Commit bc8fc2ed authored by Jim Nelson's avatar Jim Nelson

Fixes Valadoc errors.

parent f83fd646
......@@ -43,8 +43,9 @@ public abstract class Geary.ProgressMonitor : BaseObject {
public signal void finish();
/**
* Users must call this before calling update. Must not be called again until
* {@link notify_finish()} has been called.
* Users must call this before calling update.
*
* Must not be called again until {@link ProgressMonitor.notify_finish} has been called.
*/
public virtual void notify_start() {
assert(!is_in_progress);
......@@ -55,7 +56,9 @@ public abstract class Geary.ProgressMonitor : BaseObject {
}
/**
* Users must call this when progress has completed. Must only be called after {@link notify_start()}
* Users must call this when progress has completed.
*
* Must only be called after {@link ProgressMonitor.notify_start}.
*/
public virtual void notify_finish() {
assert(is_in_progress);
......@@ -77,8 +80,11 @@ public class Geary.SimpleProgressMonitor : Geary.ProgressMonitor {
}
/**
* Updates the progress by the given value. Must be between {@link MIN} and {@link MAX}. Must only
* be called after {@link notify_start()} and before {@link notify_finish()}
* Updates the progress by the given value. Must be between {@link ProgressMonitor.MIN} and
* {@link ProgressMonitor.MAX}.
*
* Must only be called after {@link ProgressMonitor.notify_start} and before
* {@link ProgressMonitor.notify_finish}.
*/
public void increment(double value) {
assert(value > 0);
......
......@@ -27,10 +27,10 @@ public class Geary.Imap.SearchCriteria : ListParameter {
}
/**
* Clears the {@link SearchCriteria} and sets the supplied {@SearchCriterion} to the first in
* the list.
* Clears the {@link SearchCriteria} and sets the supplied {@link SearchCriterion} to the first
* in the list.
*
* @returns This SearchCriteria for chaining.
* @return This SearchCriteria for chaining.
*/
public unowned SearchCriteria is_(SearchCriterion first) {
clear();
......@@ -40,9 +40,9 @@ public class Geary.Imap.SearchCriteria : ListParameter {
}
/**
* AND another {@link SearchCriterion} to the {@link SearchCriteria).
* AND another {@link SearchCriterion} to the {@link SearchCriteria}.
*
* @returns This SearchCriteria for chaining.
* @return This SearchCriteria for chaining.
*/
public unowned SearchCriteria and(SearchCriterion next) {
add(next.to_parameter());
......@@ -51,9 +51,9 @@ public class Geary.Imap.SearchCriteria : ListParameter {
}
/**
* OR another {@link SearchCriterion} to the {@link SearchCriteria).
* OR another {@link SearchCriterion} to the {@link SearchCriteria}.
*
* @returns This SearchCriteria for chaining.
* @return This SearchCriteria for chaining.
*/
public unowned SearchCriteria or(SearchCriterion a, SearchCriterion b) {
add(SearchCriterion.or(a, b).to_parameter());
......
......@@ -40,8 +40,6 @@ public class Geary.Imap.SearchCriterion : BaseObject {
/**
* Create a single criterion with a simple name and custom value.
*
* @throws ImapError.INVALID if name must be transmitted as a {@link LiteralParameter}.
*/
public SearchCriterion.string_value(string name, string value) {
Parameter? valuep = StringParameter.get_best_for(value);
......
......@@ -51,7 +51,7 @@ public class Geary.Imap.ListParameter : Geary.Imap.Parameter {
* The same {@link Parameter} can't be added more than once to the same {@link ListParameter}.
* There are no other restrictions, however.
*
* @returns true if added.
* @return true if added.
*/
public bool add(Parameter param) {
// if adding a ListParameter, set its parent
......@@ -63,7 +63,7 @@ public class Geary.Imap.ListParameter : Geary.Imap.Parameter {
}
/**
* Appends the {@ListParameter} to the end of this ListParameter.
* Appends the {@link ListParameter} to the end of this ListParameter.
*
* The difference between this call and {@link add} is that add() will simply insert the
* {@link Parameter} to the tail of the list. Thus, add(ListParameter) will add a child list
......@@ -80,7 +80,7 @@ public class Geary.Imap.ListParameter : Geary.Imap.Parameter {
* returns empty. This is slightly different than {@link adopt_children}, which preserves the
* list structure.
*
* @returns Number of added elements. append() will not abort if an element fails to add.
* @return Number of added elements. append() will not abort if an element fails to add.
*/
public int append(ListParameter listp) {
// snap the child list off the supplied ListParameter so it's wiped clean
......
......@@ -135,8 +135,10 @@ public string remove_html_tags(string input) {
return input;
}
/** Does a very approximate conversion from HTML to text. This does more than
* stripping tags -- it inserts line breaks where appropriate, decodes
/**
* Does a very approximate conversion from HTML to text.
*
* This does more than stripping tags -- it inserts line breaks where appropriate, decodes
* entities, etc. The layout of the text is largely lost. This is primarily
* useful for pulling out tokens for searching, not for presenting to the user.
*/
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment