Skip to content

Commit 9eed60b

Browse files
committed
multiboot2: Remove unnecessary information from doc strings.
1 parent 02b53ce commit 9eed60b

File tree

1 file changed

+18
-34
lines changed

1 file changed

+18
-34
lines changed

multiboot2/src/builder/information.rs

Lines changed: 18 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -287,15 +287,13 @@ impl InformationBuilder {
287287
Self::build_add_bytes(bytes, &EndTag::default().struct_as_bytes(), true);
288288
}
289289

290-
/// Adds a 'basic memory information' tag (represented by [`BasicMemoryInfoTag`]) to the builder to later build the
291-
/// boot information from.
290+
/// Adds a 'basic memory information' tag (represented by [`BasicMemoryInfoTag`]) to the builder.
292291
pub fn basic_memory_info_tag(mut self, basic_memory_info_tag: BasicMemoryInfoTag) -> Self {
293292
self.basic_memory_info_tag = Some(basic_memory_info_tag);
294293
self
295294
}
296295

297-
/// Adds a 'bootloader name' tag (represented by [`BootLoaderNameTag`]) to the builder to later build the
298-
/// boot information from.
296+
/// Adds a 'bootloader name' tag (represented by [`BootLoaderNameTag`]) to the builder.
299297
pub fn bootloader_name_tag(
300298
mut self,
301299
boot_loader_name_tag: BoxedDst<BootLoaderNameTag>,
@@ -304,106 +302,92 @@ impl InformationBuilder {
304302
self
305303
}
306304

307-
/// Adds a 'command line' tag (represented by [`CommandLineTag`]) to the builder to later build the
308-
/// boot information from.
305+
/// Adds a 'command line' tag (represented by [`CommandLineTag`]) to the builder.
309306
pub fn command_line_tag(mut self, command_line_tag: BoxedDst<CommandLineTag>) -> Self {
310307
self.command_line_tag = Some(command_line_tag);
311308
self
312309
}
313310

314-
/// Adds a 'EFI 32-bit system table pointer' tag (represented by [`EFISdt32Tag`]) to the builder to later build the
315-
/// boot information from.
311+
/// Adds a 'EFI 32-bit system table pointer' tag (represented by [`EFISdt32Tag`]) to the builder.
316312
pub fn efisdt32_tag(mut self, efisdt32: EFISdt32Tag) -> Self {
317313
self.efisdt32_tag = Some(efisdt32);
318314
self
319315
}
320316

321-
/// Adds a 'EFI 64-bit system table pointer' tag (represented by [`EFISdt64Tag`]) to the builder to later build the
322-
/// boot information from.
317+
/// Adds a 'EFI 64-bit system table pointer' tag (represented by [`EFISdt64Tag`]) to the builder.
323318
pub fn efisdt64_tag(mut self, efisdt64: EFISdt64Tag) -> Self {
324319
self.efisdt64_tag = Some(efisdt64);
325320
self
326321
}
327322

328-
/// Adds a 'EFI boot services not terminated' tag (represented by [`EFIBootServicesNotExitedTag`]) to the builder
329-
/// to later build the boot information from.
323+
/// Adds a 'EFI boot services not terminated' tag (represented by [`EFIBootServicesNotExitedTag`]) to the builder.
330324
pub fn efi_boot_services_not_exited_tag(mut self) -> Self {
331325
self.efi_boot_services_not_exited_tag = Some(EFIBootServicesNotExitedTag::new());
332326
self
333327
}
334328

335-
/// Adds a 'EFI 32-bit image handle pointer' tag (represented by [`EFIImageHandle32Tag`]) to the builder
336-
/// to later build the boot information from.
329+
/// Adds a 'EFI 32-bit image handle pointer' tag (represented by [`EFIImageHandle32Tag`]) to the builder.
337330
pub fn efi_image_handle32(mut self, efi_image_handle32: EFIImageHandle32Tag) -> Self {
338331
self.efi_image_handle32 = Some(efi_image_handle32);
339332
self
340333
}
341334

342-
/// Adds a 'EFI 64-bit image handle pointer' tag (represented by [`EFIImageHandle64Tag`]) to the builder
343-
/// to later build the boot information from.
335+
/// Adds a 'EFI 64-bit image handle pointer' tag (represented by [`EFIImageHandle64Tag`]) to the builder.
344336
pub fn efi_image_handle64(mut self, efi_image_handle64: EFIImageHandle64Tag) -> Self {
345337
self.efi_image_handle64 = Some(efi_image_handle64);
346338
self
347339
}
348340

349-
/// Adds a 'EFI Memory map' tag (represented by [`EFIMemoryMapTag`]) to the builder
350-
/// to later build the boot information from.
341+
/// Adds a 'EFI Memory map' tag (represented by [`EFIMemoryMapTag`]) to the builder.
351342
pub fn efi_memory_map_tag(mut self, efi_memory_map_tag: BoxedDst<EFIMemoryMapTag>) -> Self {
352343
self.efi_memory_map_tag = Some(efi_memory_map_tag);
353344
self
354345
}
355346

356-
/// Adds a 'ELF-Symbols' tag (represented by [`ElfSectionsTag`]) to the builder
357-
/// to later build the boot information from.
347+
/// Adds a 'ELF-Symbols' tag (represented by [`ElfSectionsTag`]) to the builder.
358348
pub fn elf_sections_tag(mut self, elf_sections_tag: BoxedDst<ElfSectionsTag>) -> Self {
359349
self.elf_sections_tag = Some(elf_sections_tag);
360350
self
361351
}
362352

363-
/// Adds a 'Framebuffer info' tag (represented by [`FramebufferTag`]) to the builder
364-
/// to later build the boot information from.
353+
/// Adds a 'Framebuffer info' tag (represented by [`FramebufferTag`]) to the builder.
365354
pub fn framebuffer_tag(mut self, framebuffer_tag: BoxedDst<FramebufferTag>) -> Self {
366355
self.framebuffer_tag = Some(framebuffer_tag);
367356
self
368357
}
369358

370-
/// Adds a 'Image load base physical address' tag (represented by [`ImageLoadPhysAddrTag`]) to the builder
371-
/// to later build the boot information from.
359+
/// Adds a 'Image load base physical address' tag (represented by [`ImageLoadPhysAddrTag`]) to the builder.
372360
pub fn image_load_addr(mut self, image_load_addr: ImageLoadPhysAddrTag) -> Self {
373361
self.image_load_addr = Some(image_load_addr);
374362
self
375363
}
376364

377-
/// Adds a (*none EFI*) 'memory map' tag (represented by [`MemoryMapTag`]) to the builder
378-
/// to later build the boot information from.
365+
/// Adds a (*none EFI*) 'memory map' tag (represented by [`MemoryMapTag`]) to the builder.
379366
pub fn memory_map_tag(mut self, memory_map_tag: BoxedDst<MemoryMapTag>) -> Self {
380367
self.memory_map_tag = Some(memory_map_tag);
381368
self
382369
}
383370

384-
/// Adds a 'Modules' tag (represented by [`ModuleTag`]) to the builder
385-
/// to later build the boot information from. This tag can occur multiple times in boot information.
371+
/// Adds a 'Modules' tag (represented by [`ModuleTag`]) to the builder.
372+
/// This tag can occur multiple times in boot information.
386373
pub fn add_module_tag(mut self, module_tag: BoxedDst<ModuleTag>) -> Self {
387374
self.module_tags.push(module_tag);
388375
self
389376
}
390377

391-
/// Adds a 'ACPI old RSDP' tag (represented by [`RsdpV1Tag`]) to the builder
392-
/// to later build the boot information from.
378+
/// Adds a 'ACPI old RSDP' tag (represented by [`RsdpV1Tag`]) to the builder.
393379
pub fn rsdp_v1_tag(mut self, rsdp_v1_tag: RsdpV1Tag) -> Self {
394380
self.rsdp_v1_tag = Some(rsdp_v1_tag);
395381
self
396382
}
397383

398-
/// Adds a 'ACPI new RSDP' tag (represented by [`RsdpV2Tag`]) to the builder
399-
/// to later build the boot information from.
384+
/// Adds a 'ACPI new RSDP' tag (represented by [`RsdpV2Tag`]) to the builder.
400385
pub fn rsdp_v2_tag(mut self, rsdp_v2_tag: RsdpV2Tag) -> Self {
401386
self.rsdp_v2_tag = Some(rsdp_v2_tag);
402387
self
403388
}
404389

405-
/// Adds a 'SMBIOS tables' tag (represented by [`SmbiosTag`]) to the builder
406-
/// to later build the boot information from.
390+
/// Adds a 'SMBIOS tables' tag (represented by [`SmbiosTag`]) to the builder.
407391
pub fn add_smbios_tag(mut self, smbios_tag: BoxedDst<SmbiosTag>) -> Self {
408392
self.smbios_tags.push(smbios_tag);
409393
self

0 commit comments

Comments
 (0)