documentation comment not proper walkme.

Created on 10 May 2023, about 1 year ago

Problem/Motivation

Since that is a method inherited from a parent class or defined in an interface, the documentation comment does not need to give all that data.

class WalkmeForm extends ConfigFormBase {

  /**
   * Implements ConfigFormBase::getEditableConfigNames.
   */
  protected function getEditableConfigNames() {
    return [
      'walkme.settings',
    ];
  }

  /**
   * Implements FormBuilder::getFormId.
   */
  public function getFormId() {
    return 'walkme_form';
  }

  /**
   * Implements FormBuilder::buildForm.
   */
  public function buildForm(array $form, FormStateInterface $form_state) {

    $config = $this->config('walkme.settings');

    $form['walkme_scope'] = [
      '#type' => 'select',
      '#title' => ('Script Scope'),
      '#options' => [
        'header' => t('Header'),
        'footer' => t('Footer'),
      ],
      '#default_value' => $config->get('walkme_scope', ''),
      '#description' => t('Where do you want to please walkme, header or footer.'),
    ];

    $form['walkme_script'] = [
      '#title' => t('Script'),
      '#type' => 'textarea',
      '#description' => t('Published script from WalkMe. Add script with out script tags.'),
      '#default_value' => $config->get('walkme_script', ''),
    ];

    return parent::buildForm($form, $form_state);
  }

  /**
   * Implements FormBuilder::validateForm().
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
  }

  /**
   * Implements FormBuilder::submitForm().
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    $this->config('walkme.settings')
      ->set('walkme_scope', $form_state->getValue('walkme_scope'))
      ->set('walkme_script', $form_state->getValue('walkme_script'))
      ->save(TRUE);
  }

Steps to reproduce

Proposed resolution

Remaining tasks

User interface changes

API changes

Data model changes

📌 Task
Status

Fixed

Component

Documentation

Created by

🇮🇳India Shiv_Sharma

Live updates comments and jobs are added and updated live.
  • Coding standards

    It involves compliance with, or the content of coding standards. Requires broad community agreement.

Sign in to follow issues

Comments & Activities

Production build 0.69.0 2024