language-servers/rust-analyzer
1
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer.git synced 2025-09-28 12:54:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Add doc strings

Browse source
This commit is contained in:
Ddystopia 2023-04-25 20:16:28 +02:00
parent c47a34fddc
commit 3fbb48907e
No known key found for this signature in database
GPG key ID: 109875EC11535212
2 changed files with 9 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
crates/ide/src/doc_links.rs
View file

@ -35,10 +35,10 @@ use crate::{
#[derive(Default, Debug, Clone, PartialEq, Eq)]
pub struct DocumentationLinks {
/// The URL to the documentation on docs.rs.
/// Could be invalid.
/// May not lead anywhere.
pub web_url: Option<String>,
/// The URL to the documentation in the local file system.
/// Could be invalid.
/// May not lead anywhere.
pub local_url: Option<String>,
}
@ -119,7 +119,7 @@ pub(crate) fn remove_links(markdown: &str) -> String {
// Feature: Open Docs
//
// Retrieve a link to documentation for the given symbol.
// Retrieve a links to documentation for the given symbol.
//
// The simplest way to use this feature is via the context menu. Right-click on
// the selected item. The context menu opens. Select **Open Docs**.
@ -459,6 +459,8 @@ fn map_links<'e>(
/// ```ignore
/// https://doc.rust-lang.org/std/iter/trait.Iterator.html#tymethod.next
/// ^^^^^^^^^^^^^^^^^^^^^^^^^^
/// file:///project/root/target/doc/std/iter/trait.Iterator.html#tymethod.next
/// ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
/// ```
fn get_doc_base_urls(
db: &RootDatabase,