Commit faf4fab3 authored by Andreas Kusalananda Kähäri's avatar Andreas Kusalananda Kähäri
Browse files

Add documentation for the get_all_object_xrefs() method.

parent 7d431df3
......@@ -684,6 +684,32 @@ sub get_all_DBEntries {
return $self->{$cache_name};
} ## end sub get_all_DBEntries
=head2 get_all_object_xrefs
Arg [1] : (optional) String, external database name
Arg [2] : (optional) String, external_db type
Example : @oxrefs = @{ $gene->get_all_object_xrefs() };
Description: Retrieves xrefs for this gene. This does *not*
include xrefs that are associated with the
transcripts or corresponding translations of this
gene (see get_all_xrefs()).
This method will attempt to lazy-load xrefs from a
database if an adaptor is available and no xrefs are
present on the gene (i.e. they have not already been
added or loaded).
NB: This method is an alias for get_all_DBentries()
Return type: Listref of Bio::EnsEMBL::DBEntry objects
Status : Stable
=cut
sub get_all_object_xrefs {
my $self = shift;
return $self->get_all_DBEntries(@_);
......
......@@ -283,6 +283,32 @@ sub get_all_DBEntries {
return $self->{$cache_name};
} ## end sub get_all_DBEntries
=head2 get_all_object_xrefs
Arg [1] : (optional) String, external database name
Arg [2] : (optional) String, external_db type
Example : @oxrefs = @{ $transcript->get_all_object_xrefs() };
Description: Retrieves xrefs for this transcript. This does
*not* include xrefs that are associated with the
corresponding translations of this transcript (see
get_all_xrefs()).
This method will attempt to lazy-load xrefs from a
database if an adaptor is available and no xrefs are
present on the transcript (i.e. they have not already
been added or loaded).
NB: This method is an alias for get_all_DBentries()
Return type: Listref of Bio::EnsEMBL::DBEntry objects
Status : Stable
=cut
sub get_all_object_xrefs {
my $self = shift;
return $self->get_all_DBEntries(@_);
......
......@@ -602,6 +602,29 @@ sub get_all_DBEntries {
return $self->{$cache_name};
} ## end sub get_all_DBEntries
=head2 get_all_object_xrefs
Arg [1] : (optional) String, external database name
Arg [2] : (optional) String, external_db type
Example : @oxrefs = @{ $translation->get_all_object_xrefs() };
Description: Retrieves xrefs for this translation.
This method will attempt to lazy-load xrefs from a
database if an adaptor is available and no xrefs
are present on the translation (i.e. they have not
already been added or loaded).
NB: This method is an alias for get_all_DBentries()
Return type: Listref of Bio::EnsEMBL::DBEntry objects
Status : Stable
=cut
sub get_all_object_xrefs {
my $self = shift;
return $self->get_all_DBEntries(@_);
......
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