noahsettersten commited on
Commit
cb8dc08
1 Parent(s): 5a4cebf

docs: Add moduledocs to some modules

Browse files
lib/medical_transcription/audio/utilities.ex CHANGED
@@ -1,4 +1,7 @@
1
  defmodule MedicalTranscription.Audio.Utilities do
 
 
 
2
  def filter_silence(samples, state) do
3
  samples
4
  |> generate_chunks(state.vad_chunk_size)
 
1
  defmodule MedicalTranscription.Audio.Utilities do
2
+ @moduledoc """
3
+ Holds audio processing utility functions.
4
+ """
5
  def filter_silence(samples, state) do
6
  samples
7
  |> generate_chunks(state.vad_chunk_size)
lib/medical_transcription/code_feedback.ex CHANGED
@@ -1,4 +1,7 @@
1
  defmodule MedicalTranscription.CodeFeedback do
 
 
 
2
  use Ecto.Schema
3
 
4
  schema "code_feedbacks" do
 
1
  defmodule MedicalTranscription.CodeFeedback do
2
+ @moduledoc """
3
+ Represents a user's feedback on a given code classification.
4
+ """
5
  use Ecto.Schema
6
 
7
  schema "code_feedbacks" do
lib/medical_transcription_web/components/components.ex CHANGED
@@ -1,4 +1,8 @@
1
  defmodule MedicalTranscriptionWeb.Components do
 
 
 
 
2
  use Phoenix.Component
3
  import MedicalTranscriptionWeb.CoreComponents
4
  alias MedicalTranscriptionWeb.Components.TranscriptionTextComponent
 
1
  defmodule MedicalTranscriptionWeb.Components do
2
+ @moduledoc """
3
+ Functional UI components for the main transcription and coding view.
4
+ """
5
+
6
  use Phoenix.Component
7
  import MedicalTranscriptionWeb.CoreComponents
8
  alias MedicalTranscriptionWeb.Components.TranscriptionTextComponent
lib/medical_transcription_web/components/keyword_highlighter.ex CHANGED
@@ -1,4 +1,8 @@
1
  defmodule MedicalTranscriptionWeb.Components.KeywordHighlighter do
 
 
 
 
2
  use MedicalTranscriptionWeb, :html
3
  # alias Phoenix.HTML.Tag
4
 
 
1
  defmodule MedicalTranscriptionWeb.Components.KeywordHighlighter do
2
+ @moduledoc """
3
+ Highlights keywords in transcription text by creating <span> tags for each.
4
+ """
5
+
6
  use MedicalTranscriptionWeb, :html
7
  # alias Phoenix.HTML.Tag
8
 
lib/medical_transcription_web/components/transcription_text_component.ex CHANGED
@@ -1,4 +1,8 @@
1
  defmodule MedicalTranscriptionWeb.Components.TranscriptionTextComponent do
 
 
 
 
2
  use MedicalTranscriptionWeb, :live_component
3
  import MedicalTranscriptionWeb.Components
4
  import MedicalTranscriptionWeb.Components.KeywordHighlighter
 
1
  defmodule MedicalTranscriptionWeb.Components.TranscriptionTextComponent do
2
+ @moduledoc """
3
+ Represents a portion of transcribed text and its codes and starts a task to determine keywords within the text.
4
+ """
5
+
6
  use MedicalTranscriptionWeb, :live_component
7
  import MedicalTranscriptionWeb.Components
8
  import MedicalTranscriptionWeb.Components.KeywordHighlighter
lib/medical_transcription_web/live/home_live/sample_results.ex CHANGED
@@ -1,4 +1,8 @@
1
  defmodule MedicalTranscriptionWeb.HomeLive.Index.SampleResults do
 
 
 
 
2
  alias AudioTagger.Structs.TagResult
3
 
4
  def get_sample_results() do
 
1
  defmodule MedicalTranscriptionWeb.HomeLive.Index.SampleResults do
2
+ @moduledoc """
3
+ Contains sample data that can be displayed in HomeLive for prototyping UI.
4
+ """
5
+
6
  alias AudioTagger.Structs.TagResult
7
 
8
  def get_sample_results() do